com.bonzaiengine.texture

Interface ITexture

All Superinterfaces:

java.lang.Cloneable

All Known Subinterfaces:

ITextureCompressed

All Known Implementing Classes:

TextureATI1, TextureATI2, TextureByte, TextureDXT1, TextureDXT3, TextureDXT5, TextureEtc1, TextureFloat

public interface ITexture
extends java.lang.Cloneable

Cubemap ordering:
GL_TEXTURE_CUBE_MAP_POSITIVE_X
GL_TEXTURE_CUBE_MAP_NEGATIVE_X
GL_TEXTURE_CUBE_MAP_POSITIVE_Y
GL_TEXTURE_CUBE_MAP_NEGATIVE_Y
GL_TEXTURE_CUBE_MAP_POSITIVE_Z
GL_TEXTURE_CUBE_MAP_NEGATIVE_Z

Method Summary

Modifier and Type	Method and Description
ITexture	clone()
void	flip(boolean flipWidth, boolean flipHeight)
TextureID.AlphaMode	getAlphaMode(int treshold)
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()
int	getDepth()
int	getFormat()
int	getHeight()
int	getInternalFormat(IGL gl, int channelBits)
int	getLevelDepth(int depth)
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)
TextureID.RgbMode	getRgbMode(int treshold)
int	getSizeInBytes(int level)
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 rgbMode, TextureID.AlphaMode alphaMode)
void	setColor(int texture, int level, int x, int y, int z, int color) Set the color of the texel at (col, line)

Method Detail

clone

ITexture clone()

getWidth

int getWidth()

Returns:

the width of the texture

getHeight

int getHeight()

Returns:

the height of the texture

getDepth

int getDepth()

Returns:

the depth of the texture

getNumChannels

int getNumChannels()

Returns:

the number of channels

hasAlpha

boolean hasAlpha()

Returns:

true if the last component is alpha

getNumLevels

int getNumLevels()

Number of mipmap levels. Same for all textures

getNumTextures

int getNumTextures()

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

Returns:

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

getLevelHeight

int getLevelHeight(int level)

Returns:

height of the specified level

getLevelWidth

int getLevelWidth(int level)

Returns:

width of the specified level

getLevelDepth

int getLevelDepth(int depth)

Returns:

depth of the specified level

flip

void flip(boolean flipWidth,
          boolean flipHeight)

Parameters:

flipWidth - true to flip texture horizontally

flipHeight - true to flip texture vertically

Throws:

java.lang.UnsupportedOperationException - if not supported (compressed texture can't be flipped horizontally)

getSizeInBytes

int getSizeInBytes(int level)

Returns:

number of bytes of the texture

See Also:

getRaw(int, int, ByteBuffer)

getOffsetInBytes

int getOffsetInBytes(int texture,
                     int level)

getRaw

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

Parameters:

texture - sub texture index to retrieve data

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

getRaw

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

Parameters:

texture - sub texture index to retrieve data

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

getRaw

byte[] getRaw()

getInternalFormat

int getInternalFormat(IGL gl,
                      int channelBits)

Parameters:

gl -

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.

getFormat

int getFormat()

Returns:

OpenGL format of the texture represented by 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)

getDataType

int getDataType()

Returns:

OpenGL data type of getRaw()

getColor

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

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

Parameters:

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

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

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

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

Returns:

the color component requested

setColor

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

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

Parameters:

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

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

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

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

setChannel

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)

Parameters:

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

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

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

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

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

getChannel

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)

Parameters:

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

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

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

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

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

Returns:

the color component requested

getRgbMode

TextureID.RgbMode getRgbMode(int treshold)

Parameters:

treshold -

Returns:

the rgb channels mode flag

getAlphaMode

TextureID.AlphaMode getAlphaMode(int treshold)

Parameters:

treshold -

Returns:

the alpha channel mode flag

setChannelMode

void setChannelMode(TextureID.RgbMode rgbMode,
                    TextureID.AlphaMode alphaMode)

Parameters:

rgbMode - rgb channel mode flag

alphaMode - alpha channel mode flag