Package com.jme3.opencl

Enum Class MappingAccess

java.lang.Object

java.lang.Enum<MappingAccess>

com.jme3.opencl.MappingAccess

All Implemented Interfaces:

Serializable, Comparable<MappingAccess>, Constable

public enum MappingAccess
extends Enum<MappingAccess>

Specifies the access flags when mapping a Buffer or Image object.

See Also:

• Buffer.map(com.jme3.opencl.CommandQueue, long, long, com.jme3.opencl.MappingAccess)
• Image.map(com.jme3.opencl.CommandQueue, long[], long[], com.jme3.opencl.MappingAccess)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MAP_READ_ONLY	Only read access is allowed to the mapped memory.
MAP_READ_WRITE	Both read and write access is allowed.
MAP_WRITE_INVALIDATE	The old memory content is completely discarded and the buffer is filled completely with new data.
MAP_WRITE_ONLY	Only write access is allowed to the mapped memory.

Method Summary

Modifier and Type	Method	Description
static MappingAccess	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MappingAccess[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MAP_READ_ONLY

public static final MappingAccess MAP_READ_ONLY

Only read access is allowed to the mapped memory.

MAP_WRITE_ONLY

public static final MappingAccess MAP_WRITE_ONLY

Only write access is allowed to the mapped memory.

MAP_READ_WRITE

public static final MappingAccess MAP_READ_WRITE

Both read and write access is allowed.

MAP_WRITE_INVALIDATE

public static final MappingAccess MAP_WRITE_INVALIDATE

The old memory content is completely discarded and the buffer is filled completely with new data. This might be faster than MAP_WRITE_ONLY

Method Details

values

public static MappingAccess[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static MappingAccess valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null