com.nativelibs4java.opencl

Enum CLMem.Flags

java.lang.Object

java.lang.Enum<CLMem.Flags>

com.nativelibs4java.opencl.CLMem.Flags

All Implemented Interfaces:

ValuedEnum, Serializable, Comparable<CLMem.Flags>

Enclosing class:

CLMem

public static enum CLMem.Flags
extends Enum<CLMem.Flags>
implements ValuedEnum

Enum Constant Summary

Enum Constants

Enum Constant and Description
AllocHostPtr This flag specifies that the application wants the OpenCL implementation to allocate memory from host accessible memory.
CopyHostPtr
ReadOnly This flag specifies that the memory object is a read-only memory object when used inside a kernel.
ReadWrite This flag specifies that the memory object will be read and written by a kernel.
UseHostPtr This flag is valid only if host_ptr is not NULL.
WriteOnly This flags specifies that the memory object will be written but not read by a kernel.

Method Summary

Modifier and Type	Method and Description
static EnumSet<CLMem.Flags>	getEnumSet(long v)
static long	getValue(EnumSet<CLMem.Flags> set)
long	value()
static CLMem.Flags	valueOf(String name) Returns the enum constant of this type with the specified name.
static CLMem.Flags[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ReadWrite

public static final CLMem.Flags ReadWrite

This flag specifies that the memory object will be read and written by a kernel. This is the default.

WriteOnly

public static final CLMem.Flags WriteOnly

This flags specifies that the memory object will be written but not read by a kernel.
Reading from a buffer or image object created with CL_MEM_WRITE_ONLY inside a kernel is undefined.

ReadOnly

public static final CLMem.Flags ReadOnly

This flag specifies that the memory object is a read-only memory object when used inside a kernel.
Writing to a buffer or image object created with CL_MEM_READ_ONLY inside a kernel is undefined.

UseHostPtr

public static final CLMem.Flags UseHostPtr

This flag is valid only if host_ptr is not NULL. If specified, it indicates that the application wants the OpenCL implementation to use memory referenced by host_ptr as the storage bits for the memory object.
OpenCL implementations are allowed to cache the buffer contents pointed to by host_ptr in device memory. This cached copy can be used when kernels are executed on a device.
The result of OpenCL commands that operate on multiple buffer objects created with the same host_ptr or overlapping host regions is considered to be undefined.

AllocHostPtr

public static final CLMem.Flags AllocHostPtr

This flag specifies that the application wants the OpenCL implementation to allocate memory from host accessible memory.
CL_MEM_ALLOC_HOST_PTR and CL_MEM_USE_HOST_PTR are mutually exclusive.
CL_MEM_COPY_HOST_PTR: This flag is valid only if host_ptr is not NULL. If specified, it indicates that the application wants the OpenCL implementation to allocate memory for the memory object and copy the data from memory referenced by host_ptr.
CL_MEM_COPY_HOST_PTR and CL_MEM_USE_HOST_PTR are mutually exclusive.
CL_MEM_COPY_HOST_PTR can be used with CL_MEM_ALLOC_HOST_PTR to initialize the contents of the cl_mem object allocated using host-accessible (e.g. PCIe) memory.

CopyHostPtr

public static final CLMem.Flags CopyHostPtr

Method Detail

values

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

Returns:

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

valueOf

public static CLMem.Flags 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

value

public long value()

Specified by:

value in interface ValuedEnum

getValue

public static long getValue(EnumSet<CLMem.Flags> set)

getEnumSet

public static EnumSet<CLMem.Flags> getEnumSet(long v)