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 inherited from class com.badlogic.gdx.graphics.GLTexture

glTarget

Constructor Summary

Constructors

Constructor and Description
Cubemap() Construct an empty Cubemap.
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

Methods

Modifier and Type	Method and Description
int	getDepth()
int	getHeight()
TextureData	getTextureData(Cubemap.CubemapSide side)
int	getWidth()
boolean	isComplete()
boolean	isManaged()
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, FileHandle file, boolean useMipMaps) 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	load(Cubemap.CubemapSide side, Pixmap pixmap, boolean useMipMaps) Sets the specified side of this cubemap to the specified Pixmap, overwriting any previous data set to that side.
void	load(Cubemap.CubemapSide side, TextureData data) Sets the specified side of this cubemap to the specified TextureData, overwriting any previous data set to that side.
void	load(TextureData positiveX, TextureData negativeX, TextureData positiveY, TextureData negativeY, TextureData positiveZ, TextureData negativeZ) Sets the sides of this cubemap to the specified TextureData.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Cubemap

public Cubemap()

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.

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(TextureData positiveX,
        TextureData negativeX,
        TextureData positiveY,
        TextureData negativeY,
        TextureData positiveZ,
        TextureData negativeZ)

Sets the sides of this cubemap to the specified TextureData.

isManaged

public boolean isManaged()

Specified by:

isManaged in class GLTexture

Returns:

whether this texture is managed or not.

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. Does not generate mipmaps. This method binds the Cubemap to the active unit!

Parameters:

side - The Cubemap.CubemapSide

file - The texture FileHandle

load

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

Loads the texture specified using the FileHandle and sets it to specified side, overwriting any previous data set to that side. This method binds the Cubemap to the active unit!

Parameters:

side - The Cubemap.CubemapSide

file - The texture FileHandle

useMipMaps - True to generate mipmaps.

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. Does not generate mipmaps. This method binds the Cubemap to the active unit!

Parameters:

side - The Cubemap.CubemapSide

pixmap - The Pixmap

load

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

Sets the specified side of this cubemap to the specified Pixmap, overwriting any previous data set to that side. This method binds the Cubemap to the active unit!

Parameters:

side - The Cubemap.CubemapSide

pixmap - The Pixmap

useMipMaps - True to generate mipmaps.

load

public void load(Cubemap.CubemapSide side,
        TextureData data)

Sets the specified side of this cubemap to the specified TextureData, overwriting any previous data set to that side. This method binds the Cubemap to the active unit!

Parameters:

side - The Cubemap.CubemapSide

data - The TextureData

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