com.bonzaiengine.texture.format

Class TextureDXT5

java.lang.Object

com.bonzaiengine.texture.format.TextureDXT5

All Implemented Interfaces:

ITexture, ITextureCompressed, java.lang.Cloneable

public final class TextureDXT5
extends java.lang.Object

Compression ratio is 4:1.

Constructor Summary

Constructors

Constructor and Description
TextureDXT5(int width, int height, int numTextures, int numLevels, byte[] data, Dds.DdsSwizzling swizzling)

Method Summary

Modifier and Type	Method and Description
TextureDXT5	clone()
void	flip(boolean flipWidth, boolean flipHeight)
TextureID.AlphaMode	getAlphaMode(int threshold)
byte	getChannel(int texture, int level, int channel, int x, int y, int z) Get the color channel / component of the texel at (col, line)
int	getColor(int texture, int level, int x, int y, int z) Get the color of the texel at (col, line)
int	getDataType()
Dds.DdsFormat	getDdsFormat()
Dds.DdsSwizzling	getDdsSwizzling()
int	getDepth()
int	getFormat()
int	getHeight()
int	getInternalFormat(IGL gl, int channelBits)
int	getLevelDepth(int level)
int	getLevelHeight(int level)
int	getLevelWidth(int level)
int	getNumChannels()
int	getNumLevels() Number of mipmap levels
int	getNumTextures() All internal texture have the same format, size, number of channels, ...
int	getOffsetInBytes(int texture, int level)
byte[]	getRaw()
void	getRaw(int texture, int level, byte[] dst)
void	getRaw(int texture, int level, java.nio.ByteBuffer dst) Buffer data for the mipmap level.
TextureID.RgbMode	getRgbMode(int threshold)
int	getSizeInBytes(int level)
Dds.DdsSwizzling	getSwizzling()
int	getWidth()
boolean	hasAlpha()
void	setChannel(int texture, int level, int channel, int x, int y, int z, byte value) Set the color channel / component of the texel at (col, line)
void	setChannelMode(TextureID.RgbMode rgbChannelMode, TextureID.AlphaMode alphaChannelMode)
void	setColor(int texture, int level, int x, int y, int z, int color) Set the color of the texel at (col, line)
void	uncompress(ITexture dst, int dstSubTexture, int dstLevel, int srcSubTexture, int srcLevel)

Methods inherited from class java.lang.Object

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

Constructor Detail

TextureDXT5

public TextureDXT5(int width,
                   int height,
                   int numTextures,
                   int numLevels,
                   byte[] data,
                   Dds.DdsSwizzling swizzling)

Method Detail

clone

public final TextureDXT5 clone()

Specified by:

clone in interface ITexture

getColor

public final int getColor(int texture,
                          int level,
                          int x,
                          int y,
                          int z)

Description copied from interface: ITexture

Get the color of the texel at (col, line)

Specified by:

getColor in interface ITexture

Parameters:

texture - index of the texture in the range [0;ITexture.getNumTextures()[ (usually 0)

x - column coordinates of the pixel. Left is 0, right is ITexture.getWidth() - 1.

y - line coordinates of the pixel. Bottom is 0, top is ITexture.getHeight() - 1.

z - depth coordinates of the pixel. Front is 0, Back is ITexture.getDepth() - 1.

Returns:

the color component requested

getInternalFormat

public final int getInternalFormat(IGL gl,
                                   int channelBits)

channelBits - number of channel bits.

• -1: default (let the hardware decide RECOMMENDED)
• 8: force 8 bits per color components/channels
• 4: force 8 bits per color components/channels
• ...

Returns:

OpenGL internal format of the pixels array.

hasAlpha

public final boolean hasAlpha()

Specified by:

hasAlpha in interface ITexture

Returns:

true if the last component is alpha

getSwizzling

public final Dds.DdsSwizzling getSwizzling()

getDdsFormat

public final Dds.DdsFormat getDdsFormat()

Returns:

Dds.DdsFormat

getDdsSwizzling

public final Dds.DdsSwizzling getDdsSwizzling()

Returns:

Dds.DdsSwizzling

getNumTextures

public final int getNumTextures()

Description copied from interface: ITexture

All internal texture have the same format, size, number of channels, ...

Specified by:

getNumTextures in interface ITexture

Returns:

the number of internal textures. Usually 1 or 6 for cubemap

getNumChannels

public final int getNumChannels()

Specified by:

getNumChannels in interface ITexture

Returns:

the number of channels

getWidth

public final int getWidth()

Specified by:

getWidth in interface ITexture

Returns:

the width of the texture

getHeight

public final int getHeight()

Specified by:

getHeight in interface ITexture

Returns:

the height of the texture

getDepth

public final int getDepth()

Specified by:

getDepth in interface ITexture

Returns:

the depth of the texture

getNumLevels

public final int getNumLevels()

Number of mipmap levels

Specified by:

getNumLevels in interface ITexture

getOffsetInBytes

public final int getOffsetInBytes(int texture,
                                  int level)

Specified by:

getOffsetInBytes in interface ITexture

getSizeInBytes

public final int getSizeInBytes(int level)

Specified by:

getSizeInBytes in interface ITexture

Returns:

number of bytes of the texture

See Also:

ITexture.getRaw(int, int, ByteBuffer)

getLevelWidth

public final int getLevelWidth(int level)

Specified by:

getLevelWidth in interface ITexture

Returns:

width of the specified level

getLevelHeight

public final int getLevelHeight(int level)

Specified by:

getLevelHeight in interface ITexture

Returns:

height of the specified level

getLevelDepth

public final int getLevelDepth(int level)

Specified by:

getLevelDepth in interface ITexture

Returns:

depth of the specified level

getRaw

public final void getRaw(int texture,
                         int level,
                         java.nio.ByteBuffer dst)

Buffer data for the mipmap level.

Specified by:

getRaw in interface ITexture

Parameters:

texture - sub texture index to retrieve data

dst - ByteBuffer with at least ITexture.getSizeInBytes(int) remaining bytes. Position is not modified

getRaw

public final void getRaw(int texture,
                         int level,
                         byte[] dst)

Specified by:

getRaw in interface ITexture

Parameters:

texture - sub texture index to retrieve data

dst - destination array with at least ITexture.getSizeInBytes(int) remaining bytes. Position is not modified

getRaw

public final byte[] getRaw()

Specified by:

getRaw in interface ITexture

flip

public void flip(boolean flipWidth,
                 boolean flipHeight)

Specified by:

flip in interface ITexture

Parameters:

flipWidth - true to flip texture horizontally

flipHeight - true to flip texture vertically

uncompress

public final void uncompress(ITexture dst,
                             int dstSubTexture,
                             int dstLevel,
                             int srcSubTexture,
                             int srcLevel)

Specified by:

uncompress in interface ITextureCompressed

getDataType

public final int getDataType()

Specified by:

getDataType in interface ITexture

Returns:

OpenGL data type of ITexture.getRaw()

getChannel

public final byte getChannel(int texture,
                             int level,
                             int channel,
                             int x,
                             int y,
                             int z)

Description copied from interface: ITexture

Get the color channel / component of the texel at (col, line)

Specified by:

getChannel in interface ITexture

Parameters:

texture - index of the texture in the range [0;ITexture.getNumTextures()[ (usually 0)

channel - index of the channel to get, in the range [0; ITexture.getNumChannels()[

x - column coordinates of the pixel. Left is 0, right is ITexture.getWidth() - 1.

y - line coordinates of the pixel. Bottom is 0, top is ITexture.getHeight() - 1.

z - depth coordinates of the pixel. Front is 0, Back is ITexture.getDepth() - 1.

Returns:

the color component requested

getFormat

public final int getFormat()

Specified by:

getFormat in interface ITexture

Returns:

OpenGL format of the texture represented by ITexture.getRaw().
Must be a valid enum of IGL.glTexImage2D(int, int, int, int, int, int, int, int, java.nio.ByteBuffer) or IGL.glCompressedTexImage2D(int, int, int, int, int, int, int, java.nio.ByteBuffer)

setColor

public final void setColor(int texture,
                           int level,
                           int x,
                           int y,
                           int z,
                           int color)

Description copied from interface: ITexture

Set the color of the texel at (col, line)

Specified by:

setColor in interface ITexture

Parameters:

texture - index of the texture in the range [0;ITexture.getNumTextures()[ (usually 0)

x - column coordinates of the pixel. Left is 0, right is ITexture.getWidth() - 1.

y - line coordinates of the pixel. Bottom is 0, top is ITexture.getHeight() - 1.

z - depth coordinates of the pixel. Front is 0, Back is ITexture.getDepth() - 1.

setChannel

public final void setChannel(int texture,
                             int level,
                             int channel,
                             int x,
                             int y,
                             int z,
                             byte value)

Description copied from interface: ITexture

Set the color channel / component of the texel at (col, line)

Specified by:

setChannel in interface ITexture

Parameters:

texture - index of the texture in the range [0;ITexture.getNumTextures()[ (usually 0)

channel - index of the channel to set, in the range [0; ITexture.getNumChannels()[

x - column coordinates of the pixel. Left is 0, right is ITexture.getWidth() - 1.

y - line coordinates of the pixel. Bottom is 0, top is ITexture.getHeight() - 1.

z - depth coordinates of the pixel. Front is 0, Back is ITexture.getDepth() - 1.

getRgbMode

public final TextureID.RgbMode getRgbMode(int threshold)

Specified by:

getRgbMode in interface ITexture

Returns:

the blend mode type of the texture

getAlphaMode

public final TextureID.AlphaMode getAlphaMode(int threshold)

Specified by:

getAlphaMode in interface ITexture

Returns:

the blend mode type of the texture

setChannelMode

public final void setChannelMode(TextureID.RgbMode rgbChannelMode,
                                 TextureID.AlphaMode alphaChannelMode)

Specified by:

setChannelMode in interface ITexture

Parameters:

rgbChannelMode - rgb channel mode flag

alphaChannelMode - alpha channel mode flag