Microsoft.Xna.Framework.Graphics

Enum StencilOperation

java.lang.Object

java.lang.Enum<StencilOperation>

Microsoft.Xna.Framework.Graphics.StencilOperation

All Implemented Interfaces:

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

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

Defines stencil buffer operations.

Author:

Halofreak1990

Enum Constant Summary

Enum Constants

Enum Constant and Description
Decrement Decrements the stencil-buffer entry, wrapping to the maximum value if the new value is less than 0.
DecrementSaturation Decrements the stencil-buffer entry, clamping to 0.
Increment Increments the stencil-buffer entry, wrapping to 0 if the new value exceeds the maximum value.
IncrementSaturation Increments the stencil-buffer entry, clamping to the maximum value.
Invert Inverts the bits in the stencil-buffer entry.
Keep Does not update the stencil-buffer entry.
Replace Replaces the stencil-buffer entry with a reference value.
Zero Sets the stencil-buffer entry to 0.

Method Summary

Methods

Modifier and Type	Method and Description
int	getValue()
static StencilOperation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StencilOperation[]	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

Keep

public static final StencilOperation Keep

Does not update the stencil-buffer entry. This is the default value.

Zero

public static final StencilOperation Zero

Sets the stencil-buffer entry to 0.

Replace

public static final StencilOperation Replace

Replaces the stencil-buffer entry with a reference value.

Increment

public static final StencilOperation Increment

Increments the stencil-buffer entry, wrapping to 0 if the new value exceeds the maximum value.

Decrement

public static final StencilOperation Decrement

Decrements the stencil-buffer entry, wrapping to the maximum value if the new value is less than 0.

IncrementSaturation

public static final StencilOperation IncrementSaturation

Increments the stencil-buffer entry, clamping to the maximum value.

DecrementSaturation

public static final StencilOperation DecrementSaturation

Decrements the stencil-buffer entry, clamping to 0.

Invert

public static final StencilOperation Invert

Inverts the bits in the stencil-buffer entry.

Method Detail

values

public static StencilOperation[] 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 (StencilOperation c : StencilOperation.values())
    System.out.println(c);

Returns:

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

valueOf

public static StencilOperation 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

getValue

public int getValue()