Microsoft.Xna.Framework.Graphics

Enum SetDataOptions

java.lang.Object

java.lang.Enum<SetDataOptions>

Microsoft.Xna.Framework.Graphics.SetDataOptions

All Implemented Interfaces:

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

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

Describes whether existing vertex or index buffer data will be overwritten or discarded during a SetData operation.

Author:

Halofreak1990

Enum Constant Summary

Enum Constants

Enum Constant and Description
Discard The SetData operation will discard the entire buffer.
None Portions of existing data in the buffer may be overwritten during this operation.
NoOverwrite The SetData operation will not overwrite existing data in the vertex and index buffers.

Method Summary

Methods

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

Discard

public static final SetDataOptions Discard

The SetData operation will discard the entire buffer. A pointer to a new memory area is returned so that the direct memory access (DMA) and rendering from the previous area do not stall.

None

public static final SetDataOptions None

Portions of existing data in the buffer may be overwritten during this operation.

NoOverwrite

public static final SetDataOptions NoOverwrite

The SetData operation will not overwrite existing data in the vertex and index buffers. Specifying this option allows the driver to return immediately from a SetData operation and continue rendering.

Method Detail

values

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

Returns:

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

valueOf

public static SetDataOptions 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()