com.bonzaiengine.texture

Class Dds

java.lang.Object

com.bonzaiengine.texture.Dds

All Implemented Interfaces:

ITextureIO

Direct Known Subclasses:

TexReader, TexWriter

public class Dds
extends java.lang.Object
implements ITextureIO

File format specification found in DirectDraw headers (ddsd.h).
And OpenGL extension texture_compression_s3tc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dds.DdsFormat
static class	Dds.DdsSwizzling

Constructor Summary

Constructors

Constructor and Description
Dds()

Method Summary

Modifier and Type	Method and Description
static ITextureCompressed	compress(ITexture texture, Dds.DdsFormat format, Dds.DdsSwizzling swizzling, boolean flip) Compress a texture
java.lang.String[]	getExtensions(boolean read)
static int	getTileTexelA_DXT3(byte[] tile, int offset, int col, int row) Used internally by ITextureCompressed implementation
static int	getTileTexelA_DXT5(byte[] tile, int offset, int col, int row) Used internally by ITextureCompressed implementation
static int	getTileTexelRGB(byte[] tile, int offset, int col, int row) Used internally by ITextureCompressed implementation
boolean	isReadSupported(Stream stream)
boolean	isWriteSupported(Stream stream)
ITexture	readTexture(Stream stream)
void	writeTexture(TextureWriterParam params, ITexture texture)

Methods inherited from class java.lang.Object

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

Constructor Detail

Dds

public Dds()

Method Detail

getTileTexelRGB

public static int getTileTexelRGB(byte[] tile,
                                  int offset,
                                  int col,
                                  int row)

Used internally by ITextureCompressed implementation

getTileTexelA_DXT3

public static int getTileTexelA_DXT3(byte[] tile,
                                     int offset,
                                     int col,
                                     int row)

Used internally by ITextureCompressed implementation

getTileTexelA_DXT5

public static int getTileTexelA_DXT5(byte[] tile,
                                     int offset,
                                     int col,
                                     int row)

Used internally by ITextureCompressed implementation

isReadSupported

public boolean isReadSupported(Stream stream)

Specified by:

isReadSupported in interface ITextureIO

Parameters:

stream - input

Returns:

true if read is supported

readTexture

public ITexture readTexture(Stream stream)
                     throws java.io.IOException

Specified by:

readTexture in interface ITextureIO

Parameters:

stream - input

Returns:

ITexture

Throws:

java.io.IOException - if fail

isWriteSupported

public boolean isWriteSupported(Stream stream)

Specified by:

isWriteSupported in interface ITextureIO

Parameters:

stream - output

Returns:

true if write is supported

writeTexture

public final void writeTexture(TextureWriterParam params,
                               ITexture texture)
                        throws java.io.IOException

Specified by:

writeTexture in interface ITextureIO

Parameters:

params - texture writer parameters

texture - texture to write

Throws:

java.io.IOException - if fail

compress

public static final ITextureCompressed compress(ITexture texture,
                                                Dds.DdsFormat format,
                                                Dds.DdsSwizzling swizzling,
                                                boolean flip)

Compress a texture

Parameters:

texture - input texture to compress

format - compression format

swizzling - compression channel swizzling

Returns:

the compressed texture, the input texture if already compressed with the requested format, or null if the format is not a compressed format or if swizzling is incompatible with the format

See Also:

TextureUtils#isValidSwizzling(DdsFormat, DdsSwizzling)

getExtensions

public java.lang.String[] getExtensions(boolean read)

Specified by:

getExtensions in interface ITextureIO

Parameters:

read - TODO

Returns:

list of extension this ITextureIO may support