com.jme3.scene
Enum VertexBuffer.Usage

java.lang.Object
  extended by java.lang.Enum<VertexBuffer.Usage>
      extended by com.jme3.scene.VertexBuffer.Usage
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<VertexBuffer.Usage>
Enclosing class:
VertexBuffer

public static enum VertexBuffer.Usage
extends java.lang.Enum<VertexBuffer.Usage>

The usage of the VertexBuffer, specifies how often the buffer is used. This can determine if a vertex buffer is placed in VRAM or held in video memory, but no guarantees are made- it's only a hint.


Enum Constant Summary
CpuOnly
          Mesh data is not sent to GPU at all.
Dynamic
          Mesh data is updated occasionally (once per frame or less).
Static
          Mesh data is sent once and very rarely updated.
Stream
          Mesh data is updated every frame.
 
Method Summary
static VertexBuffer.Usage valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static VertexBuffer.Usage[] 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

Static

public static final VertexBuffer.Usage Static
Mesh data is sent once and very rarely updated.


Dynamic

public static final VertexBuffer.Usage Dynamic
Mesh data is updated occasionally (once per frame or less).


Stream

public static final VertexBuffer.Usage Stream
Mesh data is updated every frame.


CpuOnly

public static final VertexBuffer.Usage CpuOnly
Mesh data is not sent to GPU at all. It is only used by the CPU.

Method Detail

values

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

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

valueOf

public static VertexBuffer.Usage 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