Class DDSImageWriter

java.lang.Object

javax.imageio.ImageWriter

com.twelvemonkeys.imageio.ImageWriterBase

com.twelvemonkeys.imageio.plugins.dds.DDSImageWriter

All Implemented Interfaces:

ImageTranscoder

class DDSImageWriter
extends ImageWriterBase

ImageWriter implementation for Microsoft DirectDraw Surface (DDS) format.

Field Summary

Fields

Modifier and Type	Field	Description
private long	headerStartPos
private Dimension	mipmapDimension
private final SequenceSupport	mipmapSequence
private DDSType	mipmapType

Fields inherited from class ImageWriterBase

imageOutput

Fields inherited from class ImageWriter

availableLocales, locale, originatingProvider, output, progressListeners, warningListeners, warningLocales

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DDSImageWriter(ImageWriterSpi provider)

Method Summary

Modifier and Type	Method	Description
boolean	canWriteRasters()
boolean	canWriteSequence()
IIOMetadata	convertImageMetadata(IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param)
void	endWriteSequence()
private void	ensureImageChannels(Raster data)	Checking if the image has 3 channels (RGB) or 4 channels (RGBA) and if image has 8 bits/channel.
private void	ensureTextureDimension(Raster raster)	Checking if an image can be evenly divided into blocks of 4x4, ideally a power of 2.
IIOMetadata	getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param)
DDSImageWriteParam	getDefaultWriteParam()
private static Raster	getRaster(IIOImage image)
static void	main(String[] args)
void	prepareWriteSequence(IIOMetadata streamMetadata)
protected void	resetMembers()
private void	updateHeader(int mipmapCount)
void	write(IIOMetadata streamMetadata, IIOImage image, ImageWriteParam param)
private void	writeDXT10Header(int dxgiFormat)
private void	writeFourCC(DDSType type, boolean writeDXT10)
private void	writeHeader(int width, int height, DDSType type, boolean writeDXT10)
private void	writePitchOrLinearSize(int height, int width, DDSType type)
private void	writePixelFormat(DDSType type, boolean writeDXT10)
private void	writePixelFormatFlags(DDSType type, boolean writeDXT10)
private void	writeRGBAData(DDSType type, boolean writeDXT10)
void	writeToSequence(IIOImage image, ImageWriteParam param)

Methods inherited from class ImageWriterBase

assertOutput, convertStreamMetadata, dispose, fakeAOI, fakeSubsampling, getDefaultStreamMetadata, getFormatName, getSourceRegion, reset, setOutput

Methods inherited from class ImageWriter

abort, abortRequested, addIIOWriteProgressListener, addIIOWriteWarningListener, canInsertEmpty, canInsertImage, canRemoveImage, canReplaceImageMetadata, canReplacePixels, canReplaceStreamMetadata, canWriteEmpty, clearAbortRequest, endInsertEmpty, endReplacePixels, endWriteEmpty, getAvailableLocales, getLocale, getNumThumbnailsSupported, getOriginatingProvider, getOutput, getPreferredThumbnailSizes, prepareInsertEmpty, prepareReplacePixels, prepareWriteEmpty, processImageComplete, processImageProgress, processImageStarted, processThumbnailComplete, processThumbnailProgress, processThumbnailStarted, processWarningOccurred, processWarningOccurred, processWriteAborted, removeAllIIOWriteProgressListeners, removeAllIIOWriteWarningListeners, removeIIOWriteProgressListener, removeIIOWriteWarningListener, removeImage, replaceImageMetadata, replacePixels, replacePixels, replaceStreamMetadata, setLocale, write, write, writeInsert

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

mipmapSequence

private final SequenceSupport mipmapSequence

headerStartPos

private long headerStartPos

mipmapType

private DDSType mipmapType

mipmapDimension

private Dimension mipmapDimension

Constructor Details

DDSImageWriter

protected DDSImageWriter(ImageWriterSpi provider)

Method Details

getDefaultWriteParam

public DDSImageWriteParam getDefaultWriteParam()

Overrides:

getDefaultWriteParam in class ImageWriter

resetMembers

protected void resetMembers()

Overrides:

resetMembers in class ImageWriterBase

canWriteRasters

public boolean canWriteRasters()

Overrides:

canWriteRasters in class ImageWriter

canWriteSequence

public boolean canWriteSequence()

Overrides:

canWriteSequence in class ImageWriter

prepareWriteSequence

public void prepareWriteSequence(IIOMetadata streamMetadata)
                          throws IOException

Overrides:

prepareWriteSequence in class ImageWriter

Throws:

IOException

endWriteSequence

public void endWriteSequence()
                      throws IOException

Overrides:

endWriteSequence in class ImageWriter

Throws:

IOException

write

public void write(IIOMetadata streamMetadata,
 IIOImage image,
 ImageWriteParam param)
           throws IOException

Specified by:

write in class ImageWriter

Throws:

IOException

writeToSequence

public void writeToSequence(IIOImage image,
 ImageWriteParam param)
                     throws IOException

Overrides:

writeToSequence in class ImageWriter

Throws:

IOException

getRaster

private static Raster getRaster(IIOImage image)
                         throws IIOException

Throws:

IIOException

ensureImageChannels

private void ensureImageChannels(Raster data)
                          throws IIOException

Checking if the image has 3 channels (RGB) or 4 channels (RGBA) and if image has 8 bits/channel.

Throws:

IIOException

See Also:

• DDSImageWriterSpi.canEncodeImage(ImageTypeSpecifier)

ensureTextureDimension

private void ensureTextureDimension(Raster raster)
                             throws IIOException

Checking if an image can be evenly divided into blocks of 4x4, ideally a power of 2. e.g. 16x16, 32x32, 512x128, 512x512, 1024x512, 1024x1024, 2048x1024...

Throws:

IIOException

writeHeader

private void writeHeader(int width,
 int height,
 DDSType type,
 boolean writeDXT10)
                  throws IOException

Throws:

IOException

updateHeader

private void updateHeader(int mipmapCount)
                   throws IOException

Throws:

IOException

writePixelFormat

private void writePixelFormat(DDSType type,
 boolean writeDXT10)
                       throws IOException

Throws:

IOException

writeDXT10Header

private void writeDXT10Header(int dxgiFormat)
                       throws IOException

Throws:

IOException

writeRGBAData

private void writeRGBAData(DDSType type,
 boolean writeDXT10)
                    throws IOException

Throws:

IOException

writeFourCC

private void writeFourCC(DDSType type,
 boolean writeDXT10)
                  throws IOException

Throws:

IOException

writePixelFormatFlags

private void writePixelFormatFlags(DDSType type,
 boolean writeDXT10)
                            throws IOException

Throws:

IOException

writePitchOrLinearSize

private void writePitchOrLinearSize(int height,
 int width,
 DDSType type)
                             throws IOException

Throws:

IOException

getDefaultImageMetadata

public IIOMetadata getDefaultImageMetadata(ImageTypeSpecifier imageType,
 ImageWriteParam param)

Specified by:

getDefaultImageMetadata in class ImageWriter

convertImageMetadata

public IIOMetadata convertImageMetadata(IIOMetadata inData,
 ImageTypeSpecifier imageType,
 ImageWriteParam param)

Specified by:

convertImageMetadata in interface ImageTranscoder

Specified by:

convertImageMetadata in class ImageWriter

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException