JOCL v2.6.0-rc-20250722
JOCL, OpenCL® API Binding for Java™ (public API).
com.jogamp.opencl.CLMemory< B extends Buffer >.Mem Enum Reference

Memory settings for configuring CLMemory. More...

Collaboration diagram for com.jogamp.opencl.CLMemory< B extends Buffer >.Mem:

Static Public Member Functions

static Mem valueOf (final int bufferFlag)
 
static EnumSet< MemvaluesOf (final int bitfield)
 
static int flagsToInt (final Mem[] flags)
 

Public Attributes

 READ_WRITE =(CL_MEM_READ_WRITE)
 Enum representing CL_MEM_READ_WRITE. More...
 
 WRITE_ONLY =(CL_MEM_WRITE_ONLY)
 Enum representing CL_MEM_WRITE_ONLY. More...
 
 READ_ONLY =(CL_MEM_READ_ONLY)
 Enum representing CL_MEM_READ_ONLY. More...
 
 USE_BUFFER =(CL_MEM_USE_HOST_PTR)
 Enum representing CL_MEM_USE_HOST_PTR. More...
 
 ALLOCATE_BUFFER =(CL_MEM_ALLOC_HOST_PTR)
 Enum representing CL_MEM_ALLOC_HOST_PTR. More...
 
 COPY_BUFFER =(CL_MEM_COPY_HOST_PTR)
 Enum representing CL_MEM_COPY_HOST_PTR. More...
 
final int CONFIG
 Value of wrapped OpenCL flag. More...
 

Detailed Description

Memory settings for configuring CLMemory.

Definition at line 289 of file CLMemory.java.

Member Function Documentation

◆ flagsToInt()

static int com.jogamp.opencl.CLMemory< B extends Buffer >.Mem.flagsToInt ( final Mem[]  flags)
static

Definition at line 382 of file CLMemory.java.

Here is the caller graph for this function:

◆ valueOf()

static Mem com.jogamp.opencl.CLMemory< B extends Buffer >.Mem.valueOf ( final int  bufferFlag)
static

Definition at line 351 of file CLMemory.java.

Here is the caller graph for this function:

◆ valuesOf()

static EnumSet< Mem > com.jogamp.opencl.CLMemory< B extends Buffer >.Mem.valuesOf ( final int  bitfield)
static

Definition at line 369 of file CLMemory.java.

Here is the caller graph for this function:

Member Data Documentation

◆ ALLOCATE_BUFFER

com.jogamp.opencl.CLMemory< B extends Buffer >.Mem.ALLOCATE_BUFFER =(CL_MEM_ALLOC_HOST_PTR)

Enum representing CL_MEM_ALLOC_HOST_PTR.

This flag specifies that the application wants the OpenCL implementation to allocate memory from host accessible memory. ALLOCATE_BUFFER and USE_BUFFER are mutually exclusive.

Definition at line 331 of file CLMemory.java.

◆ CONFIG

final int com.jogamp.opencl.CLMemory< B extends Buffer >.Mem.CONFIG

Value of wrapped OpenCL flag.

Definition at line 345 of file CLMemory.java.

◆ COPY_BUFFER

com.jogamp.opencl.CLMemory< B extends Buffer >.Mem.COPY_BUFFER =(CL_MEM_COPY_HOST_PTR)

Enum representing CL_MEM_COPY_HOST_PTR.

If COPY_BUFFER 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.
COPY_BUFFER and USE_BUFFER are mutually exclusive.

Definition at line 340 of file CLMemory.java.

◆ READ_ONLY

com.jogamp.opencl.CLMemory< B extends Buffer >.Mem.READ_ONLY =(CL_MEM_READ_ONLY)

Enum representing CL_MEM_READ_ONLY.

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 withREAD_ONLY inside a kernel is undefined.

Definition at line 313 of file CLMemory.java.

◆ READ_WRITE

com.jogamp.opencl.CLMemory< B extends Buffer >.Mem.READ_WRITE =(CL_MEM_READ_WRITE)

Enum representing CL_MEM_READ_WRITE.

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

Definition at line 296 of file CLMemory.java.

◆ USE_BUFFER

com.jogamp.opencl.CLMemory< B extends Buffer >.Mem.USE_BUFFER =(CL_MEM_USE_HOST_PTR)

Enum representing CL_MEM_USE_HOST_PTR.

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.

Definition at line 323 of file CLMemory.java.

◆ WRITE_ONLY

com.jogamp.opencl.CLMemory< B extends Buffer >.Mem.WRITE_ONLY =(CL_MEM_WRITE_ONLY)

Enum representing CL_MEM_WRITE_ONLY.

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 WRITE_ONLY inside a kernel is undefined.

Definition at line 305 of file CLMemory.java.


The documentation for this enum was generated from the following file: