Microsoft.Xna.Framework.Graphics

Class TextureCube

java.lang.Object

Microsoft.Xna.Framework.Graphics.GraphicsResource

Microsoft.Xna.Framework.Graphics.Texture

Microsoft.Xna.Framework.Graphics.TextureCube

All Implemented Interfaces:

IDisposable

Direct Known Subclasses:

RenderTargetCube

public class TextureCube
extends Texture

Represents a set of six 2D textures, one for each face of a cube.

Author:

Halofreak1990

Field Summary

Fields inherited from class Microsoft.Xna.Framework.Graphics.GraphicsResource

_parent, Disposing, Name, Tag

Constructor Summary

Constructors

Constructor and Description
TextureCube(GraphicsDevice graphicsDevice, int size, boolean mipMap, SurfaceFormat format) Creates a new instance of this Object.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	Dispose(boolean disposing) Immediately releases the unmanaged resources used by this Object.
protected void	finalize() Allows this Object to attempt to free resources and perform other cleanup operations before garbage collection reclaims the object.
<T extends java.lang.Number> void	GetData(CubeMapFace cubeMapFace, int level, Rectangle rect, T[] data, int startIndex, int elementCount)
<T extends java.lang.Number> void	GetData(CubeMapFace cubeMapFace, T[] data)
<T extends java.lang.Number> void	GetData(CubeMapFace cubeMapFace, T[] data, int startIndex, int elementCount)
int	getSize()
<T extends java.lang.Number> void	SetData(CubeMapFace cubeMapFace, int level, Rectangle rect, T[] data, int startIndex, int elementCount) Sets cube texture data, specifying a cubemap face, mipmap level, source rectangle, start index, and number of elements.
<T extends java.lang.Number> void	SetData(CubeMapFace cubeMapFace, T[] data) Sets cube texture data, specifying a cubemap face.
<T extends java.lang.Number> void	SetData(CubeMapFace cubeMapFace, T[] data, int startIndex, int elementCount) Sets cube texture data, specifying a cubemap face, start index, and number of elements.

Methods inherited from class Microsoft.Xna.Framework.Graphics.Texture

getFormat, getLevelCount

Methods inherited from class Microsoft.Xna.Framework.Graphics.GraphicsResource

Dispose, getGraphicsDevice, IsDisposed, raise_disposing, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TextureCube

public TextureCube(GraphicsDevice graphicsDevice,
           int size,
           boolean mipMap,
           SurfaceFormat format)

Creates a new instance of this Object.

Parameters:

graphicsDevice - The device.

size - The size (in pixels) of the top-level faces of the cube texture. Subsequent levels of each face will be the truncated value of half of the previous level's pixel dimension (independently). Each dimension is clamped to a minimum of 1 pixel.

mipMap - True to generate a full mipmap chain, false otherwise.

format - Surface data format.

Throws:

NotSupportedException

Method Detail

getSize

public int getSize()

Dispose

protected void Dispose(boolean disposing)

Description copied from class: GraphicsResource

Immediately releases the unmanaged resources used by this Object.

Overrides:

Dispose in class GraphicsResource

finalize

protected void finalize()

Description copied from class: GraphicsResource

Allows this Object to attempt to free resources and perform other cleanup operations before garbage collection reclaims the object.

Overrides:

finalize in class GraphicsResource

GetData

public <T extends java.lang.Number> void GetData(CubeMapFace cubeMapFace,
                                        T[] data)

Type Parameters:

T -

Parameters:

cubeMapFace -

data -

Throws:

ArgumentNullException - data is null.

GetData

public <T extends java.lang.Number> void GetData(CubeMapFace cubeMapFace,
                                        T[] data,
                                        int startIndex,
                                        int elementCount)

Type Parameters:

T -

Parameters:

cubeMapFace -

data -

startIndex -

elementCount -

Throws:

ArgumentNullException - data is null.

GetData

public <T extends java.lang.Number> void GetData(CubeMapFace cubeMapFace,
                                        int level,
                                        Rectangle rect,
                                        T[] data,
                                        int startIndex,
                                        int elementCount)

Type Parameters:

T -

Parameters:

cubeMapFace -

level -

rect -

data -

startIndex -

elementCount -

Throws:

ArgumentNullException - data is null.

SetData

public <T extends java.lang.Number> void SetData(CubeMapFace cubeMapFace,
                                        T[] data)

Sets cube texture data, specifying a cubemap face.

Type Parameters:

T -

Parameters:

cubeMapFace -

data -

Throws:

ArgumentNullException

SetData

public <T extends java.lang.Number> void SetData(CubeMapFace cubeMapFace,
                                        T[] data,
                                        int startIndex,
                                        int elementCount)

Sets cube texture data, specifying a cubemap face, start index, and number of elements.

Type Parameters:

T -

Parameters:

cubeMapFace -

data -

startIndex -

elementCount -

Throws:

ArgumentNullException - data is null

SetData

public <T extends java.lang.Number> void SetData(CubeMapFace cubeMapFace,
                                        int level,
                                        Rectangle rect,
                                        T[] data,
                                        int startIndex,
                                        int elementCount)

Sets cube texture data, specifying a cubemap face, mipmap level, source rectangle, start index, and number of elements.

Type Parameters:

T -

Parameters:

cubeMapFace -

level -

rect -

data -

startIndex -

elementCount -

Throws:

ArgumentNullException - data is null