com.jogamp.opencl
Enum CLMemory.Map

java.lang.Object
  extended by java.lang.Enum<CLMemory.Map>
      extended by com.jogamp.opencl.CLMemory.Map
All Implemented Interfaces:
Serializable, Comparable<CLMemory.Map>
Enclosing class:
CLMemory<B extends Buffer>

public static enum CLMemory.Map
extends Enum<CLMemory.Map>

Configures the mapping process.

See Also:
CLCommandQueue.putMapBuffer(CLBuffer, com.jogamp.opencl.CLMemory.Map, boolean)., CLCommandQueue.putMapImage(CLImage2d, com.jogamp.opencl.CLMemory.Map, boolean), CLCommandQueue.putMapImage(CLImage3d, com.jogamp.opencl.CLMemory.Map, boolean)

Enum Constant Summary
READ
          Enum representing CL_MAP_READ.
READ_WRITE
          Enum representing CL_MAP_READ | CL_MAP_WRITE.
WRITE
          Enum representing CL_MAP_WRITE.
 
Field Summary
 int FLAGS
          Value of wrapped OpenCL flag.
 
Method Summary
 CLMemory.Map valueOf(int flag)
           
static CLMemory.Map valueOf(String name)
          Returns the enum constant of this type with the specified name.
static CLMemory.Map[] 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 CLMemory.Map READ_WRITE
Enum representing CL_MAP_READ | CL_MAP_WRITE. This flag specifies that the memory object will be mapped for read and write operation.


WRITE

public static final CLMemory.Map WRITE
Enum representing CL_MAP_WRITE. This flag specifies that the memory object will be mapped for write operation.


READ

public static final CLMemory.Map READ
Enum representing CL_MAP_READ. This flag specifies that the memory object will be mapped for read operation.

Field Detail

FLAGS

public final int FLAGS
Value of wrapped OpenCL flag.

Method Detail

values

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

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

valueOf

public static CLMemory.Map valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

valueOf

public CLMemory.Map valueOf(int flag)