• 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.

• 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.

Specifies the number of channels and the channel layout i.e. the memory layout in which channels are stored in the image. Valid values are described in the table below.

• CL_R, CL_A.
• CL_INTENSITY, This format can only be used if channel data type = CL_UNORM_INT8, CL_UNORM_INT16, CL_SNORM_INT8, CL_SNORM_INT16, CL_HALF_FLOAT, or CL_FLOAT.
• CL_LUMINANCE, This format can only be used if channel data type = CL_UNORM_INT8, CL_UNORM_INT16, CL_SNORM_INT8, CL_SNORM_INT16, CL_HALF_FLOAT, or CL_FLOAT.
• CL_RG, CL_RA.
• CL_RGB, This format can only be used if channel data type = CL_UNORM_SHORT_565, CL_UNORM_SHORT_555 or CL_UNORM_INT101010.
• CL_RGBA.
• CL_ARGB, CL_BGRA. This format can only be used if channel data type = CL_UNORM_INT8, CL_SNORM_INT8, CL_SIGNED_INT8 or CL_UNSIGNED_INT8.

Describes the size of the channel data type. The number of bits per element determined by the image_channel_data_type and image_channel_order must be a power of two. The list of supported values is described in the table below.

• CL_SNORM_INT8, Each channel component is a normalized signed 8-bit integer value.
• CL_SNORM_INT16, Each channel component is a normalized signed 16-bit integer value.
• CL_UNORM_INT8, Each channel component is a normalized unsigned 8-bit integer value.
• CL_UNORM_INT16, Each channel component is a normalized unsigned 16-bit integer value.
• CL_UNORM_SHORT_565, Represents a normalized 5-6-5 3-channel RGB image. The channel order must be CL_RGB.
• CL_UNORM_SHORT_555, Represents a normalized x-5-5-5 4-channel xRGB image. The channel order must be CL_RGB.
• CL_UNORM_INT_101010, Represents a normalized x-10-10-10 4-channel xRGB image. The channel order must be CL_RGB.
• CL_SIGNED_INT8, Each channel component is an unnormalized signed 8-bit integer value.
• CL_SIGNED_INT16, Each channel component is an unnormalized signed 16-bit integer value.
• CL_SIGNED_INT32, Each channel component is an unnormalized signed 32-bit integer value.
• CL_UNSIGNED_INT8, Each channel component is an unnormalized unsigned 8-bit integer value.
• CL_UNSIGNED_INT16, Each channel component is an unnormalized unsigned 16-bit integer value.
• CL_UNSIGNED_INT32, Each channel component is an unnormalized unsigned 32-bit integer value.
• CL_HALF_FLOAT, Each channel component is a 16-bit half-float value.
• CL_FLOAT, Each channel component is a single precision floating-point value.

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.

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.

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.

Returns the mem object type.

This function execute OpenCL clGetMemObjectInfo with CL_MEM_TYPE.

Return the flags argument value specified when memobj was created.

This function execute OpenCL clGetMemObjectInfo with CL_MEM_FLAGS.

Return actual size of memobj in bytes.

This function execute OpenCL clGetMemObjectInfo with CL_MEM_SIZE.

Return the host_ptr argument value specified when memobj is created.

This function execute OpenCL clGetMemObjectInfo with CL_MEM_HOST_PTR.

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.

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.

Return context specified when memory object is created.

This function execute OpenCL clGetMemObjectInfo with CL_MEM_CONTEXT.

Creates an OpenCL buffer object from an OpenGL buffer object. Returns a valid non-zero OpenCL buffer object if the buffer object is created successfully. Otherwise it throws the CLError: * CL_INVALID_CONTEXT if context is not a valid context or was not created from a GL context.

• CL_INVALID_VALUE if values specified in flags are not valid.
• CL_INVALID_GL_OBJECT if bufobj is not a GL buffer object or is a GL buffer object but does not have an existing data store.
• CL_OUT_OF_RESOURCES if there is a failure to allocate resources required by the OpenCL implementation on the device.
• CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host.

Creates a 2D image object.

clCreateImage2D returns a valid non-zero image object created if the image 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 values specified in flags are not valid.
• CL_INVALID_IMAGE_FORMAT_DESCRIPTOR if values specified in image_format are not valid.
• CL_INVALID_IMAGE_SIZE if image_width or image_height are 0 or if they exceed values specified in CL_DEVICE_IMAGE2D_MAX_WIDTH or CL_DEVICE_IMAGE2D_MAX_HEIGHT respectively for all devices in context or if values specified by image_row_pitch do not follow rules described in the argument description above.
• CL_INVALID_HOST_PTR if host_ptr is nullPtr and CL_MEM_USE_HOST_PTR or CL_MEM_COPY_HOST_PTR are set in flags or if host_ptr is not nullPtr but CL_MEM_COPY_HOST_PTR or CL_MEM_USE_HOST_PTR are not set in flags.
• CL_IMAGE_FORMAT_NOT_SUPPORTED if the image_format is not supported.
• CL_MEM_OBJECT_ALLOCATION_FAILURE if there is a failure to allocate memory for image object.
• CL_INVALID_OPERATION if there are no devices in context that support images (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.

Creates a 3D image object.

clCreateImage3D returns a valid non-zero image object created if the image 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 values specified in flags are not valid.
• CL_INVALID_IMAGE_FORMAT_DESCRIPTOR if values specified in image_format are not valid.
• CL_INVALID_IMAGE_SIZE if image_width, image_height are 0 or if image_depth less than or equal to 1 or if they exceed values specified in CL_DEVICE_IMAGE3D_MAX_WIDTH, CL_DEVICE_IMAGE3D_MAX_HEIGHT' or CL_DEVICE_IMAGE3D_MAX_DEPTH respectively for all devices in context or if values specified by image_row_pitch and image_slice_pitch do not follow rules described in the argument description above.
• CL_INVALID_HOST_PTR if host_ptr is nullPtr and CL_MEM_USE_HOST_PTR or CL_MEM_COPY_HOST_PTR are set in flags or if host_ptr is not nullPtr but CL_MEM_COPY_HOST_PTR or CL_MEM_USE_HOST_PTR are not set in flags.
• CL_IMAGE_FORMAT_NOT_SUPPORTED if the image_format is not supported.
• CL_MEM_OBJECT_ALLOCATION_FAILURE if there is a failure to allocate memory for image object.
• CL_INVALID_OPERATION if there are no devices in context that support images (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.

Creates a 2D OpenCL image object from an existing OpenGL texture.

clCreateFromGLTexture2D returns a non-zero image object if the image object is created successfully. Otherwise, it throws one of the following CLError exceptions:

• CL_INVALID_CONTEXT if context is not a valid context or was not created from a GL context.
• CL_INVALID_VALUE if values specified in flags are not valid or if value specified in texture_target is not one of the values specified in the description of texture_target.
• CL_INVALID_MIPLEVEL if miplevel is less than the value of levelbase (for OpenGL implementations) or zero (for OpenGL ES implementations); or greater than the value of q (for both OpenGL and OpenGL ES). levelbase and q are defined for the texture in section 3.8.10 (Texture Completeness) of the OpenGL 2.1 specification and section 3.7.10 of the OpenGL ES 2.0 specification.
• CL_INVALID_MIPLEVEL if miplevel is greater than zero and the OpenGL implementation does not support creating from non-zero mipmap levels.
• CL_INVALID_GL_OBJECT if texture is not a GL texture object whose type matches texture_target, if the specified miplevel of texture is not defined, or if the width or height of the specified miplevel is zero.
• CL_INVALID_IMAGE_FORMAT_DESCRIPTOR if the OpenGL texture internal format does not map to a supported OpenCL image format.
• CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host.

Get the list of image formats supported by an OpenCL implementation. clGetSupportedImageFormats can be used to get the list of image formats supported by an OpenCL implementation when the following information about an image memory object is specified:

• Context * Image type - 2D or 3D image * Image object allocation information

Throws CL_INVALID_CONTEXT if context is not a valid context, throws CL_INVALID_VALUE if flags or image_type are not valid.

Return image format descriptor specified when image is created with clCreateImage2D or clCreateImage3D.

This function execute OpenCL clGetImageInfo with CL_IMAGE_FORMAT.

Return size of each element of the image memory object given by image. An element is made up of n channels. The value of n is given in CLImageFormat descriptor.

This function execute OpenCL clGetImageInfo with CL_IMAGE_ELEMENT_SIZE.

Return size in bytes of a row of elements of the image object given by image.

This function execute OpenCL clGetImageInfo with CL_IMAGE_ROW_PITCH.

Return size in bytes of a 2D slice for the 3D image object given by image. For a 2D image object this value will be 0.

This function execute OpenCL clGetImageInfo with CL_IMAGE_SLICE_PITCH.

Return width of image in pixels.

This function execute OpenCL clGetImageInfo with CL_IMAGE_WIDTH.

Return height of image in pixels.

This function execute OpenCL clGetImageInfo with CL_IMAGE_HEIGHT.

Return depth of the image in pixels. For a 2D image, depth equals 0.

This function execute OpenCL clGetImageInfo with CL_IMAGE_DEPTH.

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.

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.

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.

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.

Return the context specified when the sampler is created.

This function execute OpenCL clGetSamplerInfo with CL_SAMPLER_CONTEXT.

Return the value specified by addressing_mode argument to clCreateSampler.

This function execute OpenCL clGetSamplerInfo with CL_SAMPLER_ADDRESSING_MODE.

Return the value specified by filter_mode argument to clCreateSampler.

This function execute OpenCL clGetSamplerInfo with CL_SAMPLER_FILTER_MODE.

Return the value specified by normalized_coords argument to clCreateSampler.

This function execute OpenCL clGetSamplerInfo with CL_SAMPLER_NORMALIZED_COORDS.