com.badlogic.gdx.graphics.glutils

Class FacedCubemapData

java.lang.Object

com.badlogic.gdx.graphics.glutils.FacedCubemapData

All Implemented Interfaces:

CubemapData

public class FacedCubemapData
extends java.lang.Object
implements CubemapData

A FacedCubemapData holds a cubemap data definition based on a TextureData per face.

Author:

Vincent Nousquet

Field Summary

Fields

Modifier and Type	Field and Description
protected TextureData[]	data

Constructor Summary

Constructors

Constructor and Description
FacedCubemapData() Construct an empty Cubemap.
FacedCubemapData(FileHandle positiveX, FileHandle negativeX, FileHandle positiveY, FileHandle negativeY, FileHandle positiveZ, FileHandle negativeZ) Construct a Cubemap with the specified texture files for the sides, optionally generating mipmaps.
FacedCubemapData(FileHandle positiveX, FileHandle negativeX, FileHandle positiveY, FileHandle negativeY, FileHandle positiveZ, FileHandle negativeZ, boolean useMipMaps) Construct a Cubemap with the specified texture files for the sides, optionally generating mipmaps.
FacedCubemapData(int width, int height, int depth, Pixmap.Format format) Construct a Cubemap with Pixmaps for each side of the specified size.
FacedCubemapData(Pixmap positiveX, Pixmap negativeX, Pixmap positiveY, Pixmap negativeY, Pixmap positiveZ, Pixmap negativeZ) Construct a Cubemap with the specified Pixmaps for the sides, does not generate mipmaps.
FacedCubemapData(Pixmap positiveX, Pixmap negativeX, Pixmap positiveY, Pixmap negativeY, Pixmap positiveZ, Pixmap negativeZ, boolean useMipMaps) Construct a Cubemap with the specified Pixmaps for the sides, optionally generating mipmaps.
FacedCubemapData(TextureData positiveX, TextureData negativeX, TextureData positiveY, TextureData negativeY, TextureData positiveZ, TextureData negativeZ) Construct a Cubemap with the specified TextureData's for the sides

Method Summary

Modifier and Type	Method and Description
void	consumeCubemapData() Uploads the pixel data for the 6 faces of the cube to the OpenGL ES texture.
int	getHeight()
TextureData	getTextureData(Cubemap.CubemapSide side)
int	getWidth()
boolean	isComplete()
boolean	isManaged()
boolean	isPrepared()
void	load(Cubemap.CubemapSide side, FileHandle file) Loads the texture specified using the FileHandle and sets it to specified side, overwriting any previous data set to that side.
void	load(Cubemap.CubemapSide side, Pixmap pixmap) Sets the specified side of this cubemap to the specified Pixmap, overwriting any previous data set to that side.
void	prepare() Prepares the TextureData for a call to CubemapData.consumeCubemapData().

Methods inherited from class java.lang.Object

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

Field Detail

data

protected final TextureData[] data

Constructor Detail

FacedCubemapData

public FacedCubemapData()

Construct an empty Cubemap. Use the load(...) methods to set the texture of each side. Every side of the cubemap must be set before it can be used.

FacedCubemapData

public FacedCubemapData(FileHandle positiveX,
                        FileHandle negativeX,
                        FileHandle positiveY,
                        FileHandle negativeY,
                        FileHandle positiveZ,
                        FileHandle negativeZ)

Construct a Cubemap with the specified texture files for the sides, optionally generating mipmaps.

FacedCubemapData

public FacedCubemapData(FileHandle positiveX,
                        FileHandle negativeX,
                        FileHandle positiveY,
                        FileHandle negativeY,
                        FileHandle positiveZ,
                        FileHandle negativeZ,
                        boolean useMipMaps)

Construct a Cubemap with the specified texture files for the sides, optionally generating mipmaps.

FacedCubemapData

public FacedCubemapData(Pixmap positiveX,
                        Pixmap negativeX,
                        Pixmap positiveY,
                        Pixmap negativeY,
                        Pixmap positiveZ,
                        Pixmap negativeZ)

Construct a Cubemap with the specified Pixmaps for the sides, does not generate mipmaps.

FacedCubemapData

public FacedCubemapData(Pixmap positiveX,
                        Pixmap negativeX,
                        Pixmap positiveY,
                        Pixmap negativeY,
                        Pixmap positiveZ,
                        Pixmap negativeZ,
                        boolean useMipMaps)

Construct a Cubemap with the specified Pixmaps for the sides, optionally generating mipmaps.

FacedCubemapData

public FacedCubemapData(int width,
                        int height,
                        int depth,
                        Pixmap.Format format)

Construct a Cubemap with Pixmaps for each side of the specified size.

FacedCubemapData

public FacedCubemapData(TextureData positiveX,
                        TextureData negativeX,
                        TextureData positiveY,
                        TextureData negativeY,
                        TextureData positiveZ,
                        TextureData negativeZ)

Construct a Cubemap with the specified TextureData's for the sides

Method Detail

isManaged

public boolean isManaged()

Specified by:

isManaged in interface CubemapData

Returns:

whether this implementation can cope with a EGL context loss.

load

public void load(Cubemap.CubemapSide side,
                 FileHandle file)

Loads the texture specified using the FileHandle and sets it to specified side, overwriting any previous data set to that side. Note that you need to reload through Cubemap.load(CubemapData) any cubemap using this data for the change to be taken in account.

Parameters:

side - The Cubemap.CubemapSide

file - The texture FileHandle

load

public void load(Cubemap.CubemapSide side,
                 Pixmap pixmap)

Sets the specified side of this cubemap to the specified Pixmap, overwriting any previous data set to that side. Note that you need to reload through Cubemap.load(CubemapData) any cubemap using this data for the change to be taken in account.

Parameters:

side - The Cubemap.CubemapSide

pixmap - The Pixmap

isComplete

public boolean isComplete()

Returns:

True if all sides of this cubemap are set, false otherwise.

getTextureData

public TextureData getTextureData(Cubemap.CubemapSide side)

Returns:

The TextureData for the specified side, can be null if the cubemap is incomplete.

getWidth

public int getWidth()

Specified by:

getWidth in interface CubemapData

Returns:

the width of the pixel data

getHeight

public int getHeight()

Specified by:

getHeight in interface CubemapData

Returns:

the height of the pixel data

isPrepared

public boolean isPrepared()

Specified by:

isPrepared in interface CubemapData

Returns:

whether the TextureData is prepared or not.

prepare

public void prepare()

Description copied from interface: CubemapData

Prepares the TextureData for a call to CubemapData.consumeCubemapData(). This method can be called from a non OpenGL thread and should thus not interact with OpenGL.

Specified by:

prepare in interface CubemapData

consumeCubemapData

public void consumeCubemapData()

Description copied from interface: CubemapData

Uploads the pixel data for the 6 faces of the cube to the OpenGL ES texture. The caller must bind an OpenGL ES texture. A call to CubemapData.prepare() must preceed a call to this method. Any internal data structures created in CubemapData.prepare() should be disposed of here.

Specified by:

consumeCubemapData in interface CubemapData