Microsoft.Xna.Framework.Graphics
Enum CubeMapFace

java.lang.Object
  java.lang.Enum<CubeMapFace>
      Microsoft.Xna.Framework.Graphics.CubeMapFace

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CubeMapFace>

public enum CubeMapFace
extends java.lang.Enum<CubeMapFace>

Defines the faces of a cube map in the TextureCube class type.

Author:

Halofreak1990

Enum Constant Summary

NegativeX
Negative x-face of the cube map.

NegativeY
Negative y-face of the cube map.

NegativeZ
Negative z-face of the cube map.

PositiveX
Positive x-face of the cube map.

PositiveY
Positive y-face of the cube map.

PositiveZ
Positive z-face of the cube map.

Method Summary

static CubeMapFace	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CubeMapFace[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PositiveX

public static final CubeMapFace PositiveX

Positive x-face of the cube map.

NegativeX

public static final CubeMapFace NegativeX

Negative x-face of the cube map.

PositiveY

public static final CubeMapFace PositiveY

Positive y-face of the cube map.

NegativeY

public static final CubeMapFace NegativeY

Negative y-face of the cube map.

PositiveZ

public static final CubeMapFace PositiveZ

Positive z-face of the cube map.

NegativeZ

public static final CubeMapFace NegativeZ

Negative z-face of the cube map.

Method Detail

values

public static CubeMapFace[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CubeMapFace c : CubeMapFace.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CubeMapFace valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null