com.bonzaiengine.texture.format

Class TextureByte

java.lang.Object

com.bonzaiengine.texture.format.TextureByte

All Implemented Interfaces:

ITexture, java.lang.Cloneable

public class TextureByte
extends java.lang.Object
implements ITexture

A texture with byte channels.

Constructor Summary

Constructors

Constructor and Description
TextureByte(int numChannels, int width, int height, int depth)
TextureByte(int numChannels, int width, int height, int depth, boolean hasAlpha, int numTextures, int numLevels)
TextureByte(int numChannels, int width, int height, int depth, boolean hasAlpha, int numTextures, int numLevels, byte[] raw)
TextureByte(int numChannels, int width, int height, int depth, byte[] raw)

Method Summary

Modifier and Type	Method and Description
TextureByte	clone()
static void	divideByTwoUnsafe(TextureByte dst, int dstSubTexture, int dstLevel, TextureByte src, int srcSubTexture, int srcLevel) Resize a texture by 2.
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 RGB value of the pixel (col, row) color.
int	getColor(int texture, int level, int x, int y, int z) Get the color of the pixel at (col, row).
int	getDataType()
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)
TextureID.RgbMode	getRgbMode(int threshold)
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 rgba color of the pixel (col, row).
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)
static int	size(int numChannels, int width, int height, int depth, int numTextures, int numLevels)

Methods inherited from class java.lang.Object

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

Constructor Detail

TextureByte

public TextureByte(int numChannels,
                   int width,
                   int height,
                   int depth)

See Also:

TextureByte(int, int, int, int, boolean, int, int, byte[])

TextureByte

public TextureByte(int numChannels,
                   int width,
                   int height,
                   int depth,
                   boolean hasAlpha,
                   int numTextures,
                   int numLevels)

See Also:

TextureByte(int, int, int, int, boolean, int, int, byte[])

TextureByte

public TextureByte(int numChannels,
                   int width,
                   int height,
                   int depth,
                   byte[] raw)

See Also:

TextureByte(int, int, int, int, boolean, int, int, byte[])

TextureByte

public TextureByte(int numChannels,
                   int width,
                   int height,
                   int depth,
                   boolean hasAlpha,
                   int numTextures,
                   int numLevels,
                   byte[] raw)

Parameters:

numChannels - number of channels per color

width - width of the texture

height - height of the texture

depth - depth of the texture (1 for 2D texture, > 2 for 3D textures)

hasAlpha - ignored if number of channels is not 1

numTextures - number of internal textures

raw - array representation of the picture

Method Detail

size

public static final int size(int numChannels,
                             int width,
                             int height,
                             int depth,
                             int numTextures,
                             int numLevels)

clone

public final TextureByte clone()

Specified by:

clone in interface ITexture

Overrides:

clone in class java.lang.Object

setChannel

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

Set the rgba color of the pixel (col, row).
The pixel (0, 0) is the bottom left pixel of the picture.

Specified by:

setChannel in interface ITexture

Parameters:

value - red channel of the pixel's color

x - col coordinates of the pixel (0 is the first left col)

y - row coordinates of the pixel (o is the first bottom row)

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()[

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

getChannel

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

Get the RGB value of the pixel (col, row) color.
The pixel (0, 0) is the bottom left pixel of the picture.

Specified by:

getChannel in interface ITexture

Parameters:

x - col coordinates of the pixel (0 is the first left col)

y - row coordinates of the pixel (o is the first bottom row)

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()[

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

Returns:

RGB value of the the pixel (col, row) color

getColor

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

Get the color of the pixel at (col, row).
The pixel (0, 0) is the bottom left pixel of the picture.

Specified by:

getColor in interface ITexture

Parameters:

x - col coordinates of the pixel (0 is the first left col)

y - row coordinates of the pixel (o is the first bottom row)

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

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

Returns:

color in the format 0xAABBGGRR

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.

flip

public final 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

getDataType

public final int getDataType()

Specified by:

getDataType in interface ITexture

Returns:

OpenGL data type of ITexture.getRaw()

getFormat

public 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)

getInternalFormat

public int getInternalFormat(IGL gl,
                             int channelBits)

Specified by:

getInternalFormat in interface ITexture

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.

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)

getOffsetInBytes

public final int getOffsetInBytes(int texture_,
                                  int level_)

Specified by:

getOffsetInBytes in interface ITexture

getRaw

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

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

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

getNumChannels

public final int getNumChannels()

Specified by:

getNumChannels in interface ITexture

Returns:

the number of channels

getNumLevels

public final int getNumLevels()

Description copied from interface: ITexture

Number of mipmap levels. Same for all textures

Specified by:

getNumLevels in interface ITexture

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

hasAlpha

public final boolean hasAlpha()

Specified by:

hasAlpha in interface ITexture

Returns:

true if the last component is alpha

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

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

divideByTwoUnsafe

public static final void divideByTwoUnsafe(TextureByte dst,
                                           int dstSubTexture,
                                           int dstLevel,
                                           TextureByte src,
                                           int srcSubTexture,
                                           int srcLevel)

Resize a texture by 2. It is assumed that they have the same depth, number of channels and they have proper size.
Used internally for optimization of TextureUtils.resize(ITexture, int, int, int)