com.bonzaiengine.texture

Class TextureID

java.lang.Object

com.bonzaiengine.texture.TextureID

All Implemented Interfaces:

java.lang.Comparable<TextureID>

public final class TextureID
extends java.lang.Object
implements java.lang.Comparable<TextureID>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextureID.AlphaMode
static class	TextureID.RgbMode

Field Summary

Fields

Modifier and Type	Field and Description
int	id OpenGL target ID
int	target OpenGL target of the texture

Constructor Summary

Constructors

Constructor and Description
TextureID(java.lang.String name, int id, int target, int width, int height, int depth, TextureID.RgbMode rgbChannelMode, TextureID.AlphaMode alphaChannelMode)

Method Summary

Modifier and Type	Method and Description
void	bind(IGL gl)
int	compareTo(TextureID o)
boolean	equals(java.lang.Object obj)
TextureID.AlphaMode	getAlphaChannelMode()
int	getDepth()
int	getFormat()
int	getHeight()
java.lang.String	getName()
TextureID.RgbMode	getRgbChannelMode()
int	getSizeInBytes()
int	getWidth()
boolean	hasAlphaChannel()
boolean	hasRgbChannel()
boolean	isAlphaBlendChannel()
boolean	isAlphaTestChannel()
boolean	isGreyScale()
void	set(java.lang.String name, int width, int height) Internal use only
java.lang.String	toString()
void	unbind(IGL gl)

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

id

public final int id

OpenGL target ID

target

public final int target

OpenGL target of the texture

Constructor Detail

TextureID

public TextureID(java.lang.String name,
                 int id,
                 int target,
                 int width,
                 int height,
                 int depth,
                 TextureID.RgbMode rgbChannelMode,
                 TextureID.AlphaMode alphaChannelMode)

Parameters:

name - unique name referencing this texture

id - OpenGL ID of the texture

target - OpenGL target ID

width - width of the texture in pixels

height - height of the texture in pixels

rgbChannelMode -

alphaChannelMode -

Method Detail

compareTo

public final int compareTo(TextureID o)

Specified by:

compareTo in interface java.lang.Comparable<TextureID>

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getName

public final java.lang.String getName()

Returns:

the texture name associated to this TextureID

See Also:

Texture.name

getWidth

public final int getWidth()

Returns:

the texture width in pixels

getHeight

public final int getHeight()

Returns:

the texture height in pixels

getDepth

public final int getDepth()

Returns:

the texture depth in pixels

getFormat

public final int getFormat()

Returns:

the texture OpenGL internal format

getSizeInBytes

public final int getSizeInBytes()

Returns:

the texture size in bytes, including all mipmap levels (if any)

set

public final void set(java.lang.String name,
                      int width,
                      int height)

Internal use only

getRgbChannelMode

public final TextureID.RgbMode getRgbChannelMode()

hasRgbChannel

public final boolean hasRgbChannel()

getAlphaChannelMode

public final TextureID.AlphaMode getAlphaChannelMode()

isGreyScale

public final boolean isGreyScale()

hasAlphaChannel

public final boolean hasAlphaChannel()

isAlphaTestChannel

public final boolean isAlphaTestChannel()

isAlphaBlendChannel

public final boolean isAlphaBlendChannel()

bind

public final void bind(IGL gl)

unbind

public final void unbind(IGL gl)