com.jme3.opencl

Enum MemoryAccess

java.lang.Object

java.lang.Enum<MemoryAccess>

com.jme3.opencl.MemoryAccess

All Implemented Interfaces:

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

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

Specifies how a buffer object can be accessed by the kernel.

See Also:

Buffer

Enum Constant Summary

Enum Constants

Enum Constant and Description
READ_ONLY A kernel can only read this buffer
READ_WRITE A kernel can both read and write the buffer.
WRITE_ONLY A kernel can only write this buffer.

Method Summary

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

READ_WRITE

public static final MemoryAccess READ_WRITE

A kernel can both read and write the buffer.

WRITE_ONLY

public static final MemoryAccess WRITE_ONLY

A kernel can only write this buffer.

READ_ONLY

public static final MemoryAccess READ_ONLY

A kernel can only read this buffer

Method Detail

values

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

Returns:

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

valueOf

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