Microsoft.Xna.Framework.Graphics

Enum RenderTargetUsage

java.lang.Object

java.lang.Enum<RenderTargetUsage>

Microsoft.Xna.Framework.Graphics.RenderTargetUsage

All Implemented Interfaces:

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

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

Determines how render target data is used once a new render target is set.

Author:

Halofreak1990

Enum Constant Summary

Enum Constants

Enum Constant and Description
DiscardContents Always clears the render target data.
PlatformContents Either clears or keeps the data, depending on the current platform.
PreserveContents Always keeps the render target data.

Method Summary

Methods

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

DiscardContents

public static final RenderTargetUsage DiscardContents

Always clears the render target data.

PreserveContents

public static final RenderTargetUsage PreserveContents

Always keeps the render target data.

PlatformContents

public static final RenderTargetUsage PlatformContents

Either clears or keeps the data, depending on the current platform. On Xbox 360, the render target will discard contents. On PC, the render target will discard if multisampling is enabled, and preserve the contents if not.

Method Detail

values

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

Returns:

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

valueOf

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