com.bonzaiengine.texture

Class TextureUtils

java.lang.Object

com.bonzaiengine.texture.TextureUtils

public class TextureUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TextureUtils()

Method Summary

Modifier and Type	Method and Description
static ITexture	addAlphaChannel(ITexture src)
static void	alphaChannelToAlphaTest(ITexture texture)
static TextureByte	clip(TextureByte texture, Area area) Note: the clipping is performed on the first level, the other levels being discarded
static ITexture	copy(ITexture texture) Copy the src texture into the best representing uncompressed format.
static ITexture	copy(ITexture dst, int dstSubTexture, int dstLevel, ITexture src, int srcSubTexture, int srcLevel)
static ITexture	copy(ITexture dst, ITexture src) Convert the src texture into the dst texture.
static ITexture	copyRegion(ITexture dst, Area dstArea, int dstSubTexture, int dstLevel, ITexture src, Area srcArea, int srcSubTexture, int srcLevel)
static ITexture	copyRegion(ITexture dst, Area dstArea, int dstLevel, ITexture src, Area srcArea, int level)
static void	copyRToA(ITexture dst, ITexture src)
static TextureByte	createsAlphaLayer(ITexture src, int transparentColor) Transparency effect ("Alpha layer") Make a color full transparent.
static TextureByte	createsMaskEffect(ITexture mask, ITexture texture) Mask effect This effect use two pictures.
static ITexture	cubemap(ITexture[] src)
static void	fill(ITexture texture, int channel, byte color) Fill a channel with the specified color byte
static ITexture	generateMipmap(ITexture src) Generate mipmap levels.
static Dds.DdsFormat	getFormat(ITexture texture)
static int	getMaximumMipmapLevels(ITexture texture)
static Dds.DdsSwizzling	getSwizzling(ITexture texture)
static boolean	isValidSwizzling(Dds.DdsFormat ddsFormat, Dds.DdsSwizzling ddsSwizzling)
static ITexture	reduce(ITexture src, int numChannels, boolean alphaRemoved) Reduce number of channels into a new (non compressed) texture
static ITexture	resize(ITexture src, int dstWidth, int dstHeight, int dstDepth) Resize a texture
static ITexture	resize(ITexture src, int subTexture, int level, int dstWidth, int dstHeight, int dstDepth) Resize a texture
static ITexture	resize(ITexture dst, int dstSubTexture, int dstLevel, ITexture src, int srcSubTexture, int srcLevel)
static ITexture	resizeNoCopy(ITexture texture, int width, int height, int depth) identical to resize(ITexture, int, int, int) except that if no resizing is needed, it return the input texture
static ITexture	uncompress(ITextureCompressed compressedTexture, int srcSubTexture, int srcLevel) Uncompress a texture

Methods inherited from class java.lang.Object

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

Constructor Detail

TextureUtils

public TextureUtils()

Method Detail

uncompress

public static final ITexture uncompress(ITextureCompressed compressedTexture,
                                        int srcSubTexture,
                                        int srcLevel)

Uncompress a texture

Parameters:

compressedTexture -

srcSubTexture - sub texture to uncompress

srcLevel - mipmap level if to uncompress, in range of [0;ITexture.getNumLevels()[

Returns:

the uncompressed texture

getFormat

public static final Dds.DdsFormat getFormat(ITexture texture)

Parameters:

texture -

Returns:

the Dds.DdsFormat of the input texture

getSwizzling

public static final Dds.DdsSwizzling getSwizzling(ITexture texture)
                                           throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

isValidSwizzling

public static final boolean isValidSwizzling(Dds.DdsFormat ddsFormat,
                                             Dds.DdsSwizzling ddsSwizzling)
                                      throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

copy

public static final ITexture copy(ITexture texture)

Copy the src texture into the best representing uncompressed format.

Parameters:

texture - source texture to copy

Returns:

new texture containing a copy.

copy

public static final ITexture copy(ITexture dst,
                                  ITexture src)

Convert the src texture into the dst texture.

Parameters:

src - source texture to convert to dst

dst - destination texture to contains the source texture converted

Returns:

dst

Throws:

java.lang.IllegalArgumentException - if source and destination size did not match

copy

public static final ITexture copy(ITexture dst,
                                  int dstSubTexture,
                                  int dstLevel,
                                  ITexture src,
                                  int srcSubTexture,
                                  int srcLevel)

copyRegion

public static final ITexture copyRegion(ITexture dst,
                                        Area dstArea,
                                        int dstLevel,
                                        ITexture src,
                                        Area srcArea,
                                        int level)

copyRegion

public static final ITexture copyRegion(ITexture dst,
                                        Area dstArea,
                                        int dstSubTexture,
                                        int dstLevel,
                                        ITexture src,
                                        Area srcArea,
                                        int srcSubTexture,
                                        int srcLevel)

clip

public static final TextureByte clip(TextureByte texture,
                                     Area area)

Note: the clipping is performed on the first level, the other levels being discarded

Parameters:

texture - source texture

area - clipping area

Returns:

texture if no clip is needed, or the new created texture

generateMipmap

public static final ITexture generateMipmap(ITexture src)

Generate mipmap levels.
This operation can be very expensive for compressed texture.

Parameters:

src - source ITexture to generate mipmap levels

Returns:

a new ITexture with all mipmap levels, or src if ITextureCompressed or if mipmap was already computed

getMaximumMipmapLevels

public static final int getMaximumMipmapLevels(ITexture texture)

copyRToA

public static final void copyRToA(ITexture dst,
                                  ITexture src)

Parameters:

src - source texture

dst - destination texture (can be source)

Throws:

java.lang.IllegalArgumentException - if destination texture don't have alpha channel, or source and destination size did not match

fill

public static final void fill(ITexture texture,
                              int channel,
                              byte color)

Fill a channel with the specified color byte

resizeNoCopy

public static final ITexture resizeNoCopy(ITexture texture,
                                          int width,
                                          int height,
                                          int depth)

identical to resize(ITexture, int, int, int) except that if no resizing is needed, it return the input texture

resize

public static final ITexture resize(ITexture src,
                                    int dstWidth,
                                    int dstHeight,
                                    int dstDepth)

Resize a texture

Parameters:

src - texture to resize

dstWidth - resized width

dstHeight - resized height

Returns:

a new resized texture, or a copy of the source texture if same size

resize

public static final ITexture resize(ITexture src,
                                    int subTexture,
                                    int level,
                                    int dstWidth,
                                    int dstHeight,
                                    int dstDepth)

Resize a texture

Parameters:

src - texture to resize

dstWidth - resized width

dstHeight - resized height

Returns:

new texture resized, or a copy the the src texture if same size

resize

public static final ITexture resize(ITexture dst,
                                    int dstSubTexture,
                                    int dstLevel,
                                    ITexture src,
                                    int srcSubTexture,
                                    int srcLevel)

reduce

public static final ITexture reduce(ITexture src,
                                    int numChannels,
                                    boolean alphaRemoved)

Reduce number of channels into a new (non compressed) texture

cubemap

public static final ITexture cubemap(ITexture[] src)

Returns:

a ITexture[6] array to convert into a cubemap ITexture

addAlphaChannel

public static final ITexture addAlphaChannel(ITexture src)

Returns:

a new texture containing a copy

alphaChannelToAlphaTest

public static final void alphaChannelToAlphaTest(ITexture texture)

createsMaskEffect

public static final TextureByte createsMaskEffect(ITexture mask,
                                                  ITexture texture)

Mask effect
This effect use two pictures.
The mask is used to extract alpha values. The texture is used to extract rgb values.

Parameters:

mask - picture object that represents the mask

texture - picture object that represents the texture

Returns:

new allocated TextureByte containing the mask effect result

createsAlphaLayer

public static final TextureByte createsAlphaLayer(ITexture src,
                                                  int transparentColor)

Transparency effect ("Alpha layer")
Make a color full transparent.

Parameters:

src - picture object to add transparency

transparentColor - rgb color in format0x00BBGGRR.
Full color is 255, no color is 0.

Returns:

the representation of the picture