System.GPU.OpenCL.Memory

Types

type CLMem = Ptr ()

type CLSampler = Ptr ()

data CLMemFlag

• CL_MEM_READ_WRITE, This flag specifies that the memory object will be read and written by a kernel. This is the default.
• 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 CLMEM_WRITE_ONLY inside a kernel is undefined.
• 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 with CLMEM_READ_ONLY inside a kernel is undefined.
• CL_MEM_USE_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 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.
• CL_MEM_ALLOC_HOST_PTR, 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.

Constructors

CL_MEM_READ_WRITE

CL_MEM_WRITE_ONLY

CL_MEM_READ_ONLY

CL_MEM_USE_HOST_PTR

CL_MEM_ALLOC_HOST_PTR

CL_MEM_COPY_HOST_PTR

Instances

Bounded CLMemFlag

Enum CLMemFlag

Eq CLMemFlag

Ord CLMemFlag

Show CLMemFlag

data CLMemObjectType

• CL_MEM_OBJECT_BUFFER if memobj is created with clCreateBuffer.
• CL_MEM_OBJECT_IMAGE2D if memobj is created with clCreateImage2D
• CL_MEM_OBJECT_IMAGE3D if memobj is created with clCreateImage3D.

Constructors

CL_MEM_OBJECT_BUFFER

CL_MEM_OBJECT_IMAGE2D

CL_MEM_OBJECT_IMAGE3D

Instances

Enum CLMemObjectType

Show CLMemObjectType

data CLAddressingMode

Constructors

CL_ADDRESS_REPEAT

CL_ADDRESS_CLAMP_TO_EDGE

CL_ADDRESS_CLAMP

CL_ADDRESS_NONE

Instances

Enum CLAddressingMode

Show CLAddressingMode

data CLFilterMode

Constructors

CL_FILTER_NEAREST

CL_FILTER_LINEAR

Instances

Enum CLFilterMode

Show CLFilterMode

Memory Functions

clCreateBuffer :: Integral a => CLContext -> [CLMemFlag] -> (a, Ptr ()) -> IO CLMem

Creates a buffer object. Returns a valid non-zero buffer object if the buffer object is created successfully. Otherwise, it throws the CLError:

• CL_INVALID_CONTEXT if context is not a valid context.
• CL_INVALID_VALUE if values specified in flags are not valid.
• CL_INVALID_BUFFER_SIZE if size is 0 or is greater than clDeviceMaxMemAllocSize value for all devices in context.
• CL_INVALID_HOST_PTR if host_ptr is NULL and CL_MEM_USE_HOST_PTR or CL_MEM_COPY_HOST_PTR are set in flags or if host_ptr is not NULL but CL_MEM_COPY_HOST_PTR or CL_MEM_USE_HOST_PTR are not set in flags.
• CL_MEM_OBJECT_ALLOCATION_FAILURE if there is a failure to allocate memory for buffer object.
• CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host.

clRetainMemObject :: CLMem -> IO Bool

Increments the memory object reference count. returns True if the function is executed successfully. After the memobj reference count becomes zero and commands queued for execution on a command-queue(s) that use memobj have finished, the memory object is deleted. It returns False if memobj is not a valid memory object.

clReleaseMemObject :: CLMem -> IO Bool

Decrements the memory object reference count. After the memobj reference count becomes zero and commands queued for execution on a command-queue(s) that use memobj have finished, the memory object is deleted. Returns True if the function is executed successfully. It returns False if memobj is not a valid memory object.

clGetMemType :: CLMem -> IO CLMemObjectType

Returns the mem object type.

This function execute OpenCL clGetMemObjectInfo with CL_MEM_TYPE.

clGetMemFlags :: CLMem -> IO [CLMemFlag]

Return the flags argument value specified when memobj was created.

This function execute OpenCL clGetMemObjectInfo with CL_MEM_FLAGS.

clGetMemSize :: CLMem -> IO CSize

Return actual size of memobj in bytes.

This function execute OpenCL clGetMemObjectInfo with CL_MEM_SIZE.

clGetMemHostPtr :: CLMem -> IO (Ptr ())

Return the host_ptr argument value specified when memobj is created.

This function execute OpenCL clGetMemObjectInfo with CL_MEM_HOST_PTR.

clGetMemMapCount :: CLMem -> IO CLuint

Map count. The map count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for debugging.

This function execute OpenCL clGetMemObjectInfo with CL_MEM_MAP_COUNT.

clGetMemReferenceCount :: CLMem -> IO CLuint

Return memobj reference count. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.

This function execute OpenCL clGetMemObjectInfo with CL_MEM_REFERENCE_COUNT.

clGetMemContext :: CLMem -> IO CLContext

Return context specified when memory object is created.

This function execute OpenCL clGetMemObjectInfo with CL_MEM_CONTEXT.

Sampler Functions

clCreateSampler :: CLContext -> Bool -> CLAddressingMode -> CLFilterMode -> IO CLSampler

Creates a sampler object. A sampler object describes how to sample an image when the image is read in the kernel. The built-in functions to read from an image in a kernel take a sampler as an argument. The sampler arguments to the image read function can be sampler objects created using OpenCL functions and passed as argument values to the kernel or can be samplers declared inside a kernel. In this section we discuss how sampler objects are created using OpenCL functions.

Returns a valid non-zero sampler object if the sampler object is created successfully. Otherwise, it throws one of the following CLError exceptions:

• CL_INVALID_CONTEXT if context is not a valid context.
• CL_INVALID_VALUE if addressing_mode, filter_mode, or normalized_coords or a combination of these argument values are not valid.
• CL_INVALID_OPERATION if images are not supported by any device associated with context (i.e. CL_DEVICE_IMAGE_SUPPORT specified in the table of OpenCL Device Queries for clGetDeviceInfo is False).
• CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host.

clRetainSampler :: CLSampler -> IO Bool

Increments the sampler reference count. clCreateSampler does an implicit retain. Returns True if the function is executed successfully. It returns False if sampler is not a valid sampler object.

clReleaseSampler :: CLSampler -> IO Bool

Decrements the sampler reference count. The sampler object is deleted after the reference count becomes zero and commands queued for execution on a command-queue(s) that use sampler have finished. clReleaseSampler returns True if the function is executed successfully. It returns False if sampler is not a valid sampler object.

clGetSamplerReferenceCount :: CLSampler -> IO CLuint

Return the sampler reference count. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.

This function execute OpenCL clGetSamplerInfo with CL_SAMPLER_REFERENCE_COUNT.

clGetSamplerContext :: CLSampler -> IO CLContext

Return the context specified when the sampler is created.

This function execute OpenCL clGetSamplerInfo with CL_SAMPLER_CONTEXT.

clGetSamplerAddressingMode :: CLSampler -> IO CLAddressingMode

Return the value specified by addressing_mode argument to clCreateSampler.

This function execute OpenCL clGetSamplerInfo with CL_SAMPLER_ADDRESSING_MODE.

clGetSamplerFilterMode :: CLSampler -> IO CLFilterMode

Return the value specified by filter_mode argument to clCreateSampler.

This function execute OpenCL clGetSamplerInfo with CL_SAMPLER_FILTER_MODE.

clGetSamplerNormalizedCoords :: CLSampler -> IO Bool

Return the value specified by normalized_coords argument to clCreateSampler.

This function execute OpenCL clGetSamplerInfo with CL_SAMPLER_NORMALIZED_COORDS.