com.badlogic.gdx.graphics

Class Cubemap

java.lang.Object

com.badlogic.gdx.graphics.GLTexture

com.badlogic.gdx.graphics.Cubemap

All Implemented Interfaces:

Disposable

public class Cubemap
extends GLTexture

Wraps a standard OpenGL ES Cubemap. Must be disposed when it is no longer used.

Author:

Xoppa

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cubemap.CubemapSide Enum to identify each side of a Cubemap

Field Summary

Fields

Modifier and Type	Field and Description
protected CubemapData	data

Fields inherited from class com.badlogic.gdx.graphics.GLTexture

glHandle, glTarget, magFilter, minFilter, uWrap, vWrap

Constructor Summary

Constructors

Constructor and Description
Cubemap(CubemapData data) Construct a Cubemap based on the given CubemapData.
Cubemap(FileHandle positiveX, FileHandle negativeX, FileHandle positiveY, FileHandle negativeY, FileHandle positiveZ, FileHandle negativeZ) Construct a Cubemap with the specified texture files for the sides, does not generate mipmaps.
Cubemap(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.
Cubemap(int width, int height, int depth, Pixmap.Format format) Construct a Cubemap with Pixmaps for each side of the specified size.
Cubemap(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.
Cubemap(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.
Cubemap(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
static void	clearAllCubemaps(Application app) Clears all managed cubemaps.
void	dispose() Disposes all resources associated with the cubemap
CubemapData	getCubemapData()
int	getDepth()
int	getHeight()
static java.lang.String	getManagedStatus()
static int	getNumManagedCubemaps()
int	getWidth()
static void	invalidateAllCubemaps(Application app) Invalidate all managed cubemaps.
boolean	isManaged()
void	load(CubemapData data) Sets the sides of this cubemap to the specified CubemapData.
protected void	reload()
static void	setAssetManager(AssetManager manager) Sets the AssetManager.

Methods inherited from class com.badlogic.gdx.graphics.GLTexture

bind, bind, delete, getMagFilter, getMinFilter, getTextureObjectHandle, getUWrap, getVWrap, setFilter, setWrap, unsafeSetFilter, unsafeSetFilter, unsafeSetWrap, unsafeSetWrap, uploadImageData, uploadImageData

Methods inherited from class java.lang.Object

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

Field Detail

data

protected CubemapData data

Constructor Detail

Cubemap

public Cubemap(CubemapData data)

Construct a Cubemap based on the given CubemapData.

Cubemap

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

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

Cubemap

public Cubemap(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.

Cubemap

public Cubemap(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.

Cubemap

public Cubemap(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.

Cubemap

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

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

Cubemap

public Cubemap(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

load

public void load(CubemapData data)

Sets the sides of this cubemap to the specified CubemapData.

getCubemapData

public CubemapData getCubemapData()

isManaged

public boolean isManaged()

Specified by:

isManaged in class GLTexture

Returns:

whether this texture is managed or not.

reload

protected void reload()

Specified by:

reload in class GLTexture

getWidth

public int getWidth()

Specified by:

getWidth in class GLTexture

Returns:

the width of the texture in pixels

getHeight

public int getHeight()

Specified by:

getHeight in class GLTexture

Returns:

the height of the texture in pixels

getDepth

public int getDepth()

Specified by:

getDepth in class GLTexture

Returns:

the depth of the texture in pixels

dispose

public void dispose()

Disposes all resources associated with the cubemap

Specified by:

dispose in interface Disposable

Overrides:

dispose in class GLTexture

clearAllCubemaps

public static void clearAllCubemaps(Application app)

Clears all managed cubemaps. This is an internal method. Do not use it!

invalidateAllCubemaps

public static void invalidateAllCubemaps(Application app)

Invalidate all managed cubemaps. This is an internal method. Do not use it!

setAssetManager

public static void setAssetManager(AssetManager manager)

Sets the AssetManager. When the context is lost, cubemaps managed by the asset manager are reloaded by the manager on a separate thread (provided that a suitable AssetLoader is registered with the manager). Cubemaps not managed by the AssetManager are reloaded via the usual means on the rendering thread.

Parameters:

manager - the asset manager.

getManagedStatus

public static java.lang.String getManagedStatus()

getNumManagedCubemaps

public static int getNumManagedCubemaps()

Returns:

the number of managed cubemaps currently loaded