Module opencl3::memory

Structs

Buffer	An OpenCL buffer. Implements the Drop trait to call release_mem_object when the object is dropped.
Image	An OpenCL image. Has methods to return information from calls to clGetImageInfo with the appropriate parameters. Implements the Drop trait to call release_mem_object when the object is dropped.
Pipe	An OpenCL pipe. Has methods to return information from calls to clGetPipeInfo with the appropriate parameters. Implements the Drop trait to call release_mem_object when the object is dropped.
Sampler	An OpenCL sampler. Has methods to return information from calls to clGetSamplerInfo with the appropriate parameters. Implements the Drop trait to call release_sampler when the object is dropped.

Enums

ImageInfo
MemInfo
PipeInfo

Constants

CL_A
CL_ABGR
CL_ADDRESS_CLAMP
CL_ADDRESS_CLAMP_TO_EDGE
CL_ADDRESS_MIRRORED_REPEAT
CL_ADDRESS_NONE
CL_ADDRESS_REPEAT
CL_ARGB
CL_BGRA
CL_BUFFER_CREATE_TYPE_REGION
CL_DEPTH
CL_DEPTH_STENCIL
CL_FILTER_LINEAR
CL_FILTER_NEAREST
CL_FLOAT
CL_HALF_FLOAT
CL_INTENSITY
CL_LUMINANCE
CL_MAP_READ
CL_MAP_WRITE
CL_MAP_WRITE_INVALIDATE_REGION
CL_MEM_ALLOC_HOST_PTR
CL_MEM_COPY_HOST_PTR
CL_MEM_HOST_NO_ACCESS
CL_MEM_HOST_READ_ONLY
CL_MEM_HOST_WRITE_ONLY
CL_MEM_KERNEL_READ_AND_WRITE
CL_MEM_OBJECT_BUFFER
CL_MEM_OBJECT_IMAGE1D
CL_MEM_OBJECT_IMAGE1D_ARRAY
CL_MEM_OBJECT_IMAGE1D_BUFFER
CL_MEM_OBJECT_IMAGE2D
CL_MEM_OBJECT_IMAGE2D_ARRAY
CL_MEM_OBJECT_IMAGE3D
CL_MEM_OBJECT_PIPE
CL_MEM_READ_ONLY
CL_MEM_READ_WRITE
CL_MEM_SVM_ATOMICS
CL_MEM_SVM_FINE_GRAIN_BUFFER
CL_MEM_USE_HOST_PTR
CL_MEM_WRITE_ONLY
CL_MIGRATE_MEM_OBJECT_CONTENT_UNDEFINED
CL_MIGRATE_MEM_OBJECT_HOST
CL_R
CL_RA
CL_RG
CL_RGB
CL_RGBA
CL_RGBx
CL_RGx
CL_Rx
CL_SIGNED_INT8
CL_SIGNED_INT16
CL_SIGNED_INT32
CL_SNORM_INT8
CL_SNORM_INT16
CL_UNORM_INT8
CL_UNORM_INT16
CL_UNORM_INT24
CL_UNORM_INT_101010
CL_UNORM_INT_101010_2
CL_UNORM_SHORT_555
CL_UNORM_SHORT_565
CL_UNSIGNED_INT8
CL_UNSIGNED_INT16
CL_UNSIGNED_INT32
CL_sRGB
CL_sRGBA
CL_sRGBx

Traits

ClMem

Functions

clCreateBufferWithProperties⚠
clCreateImage⚠
clCreateImageWithProperties⚠
clGetSupportedImageFormats⚠
create_buffer	Create an OpenCL buffer object for a context. Calls clCreateBuffer to create an OpenCL buffer object.
create_image	Create an OpenCL image object for a context. Calls clCreateImage to create an OpenCL image object.
create_pipe	Create an OpenCL pipe object for a context. Calls clCreatePipe to create an OpenCL pipe object. CL_VERSION_2_0
create_sub_buffer	Create an new OpenCL buffer object from an existing buffer object. Calls clCreateSubBuffer to create an OpenCL sub-buffer object.
get_image_info	Get information specific to an OpenCL image object. Calls clGetImageInfo to get the desired information about the image object.
get_mem_object_info	Get information common to all OpenCL memory objects (buffer and image objects). Calls clGetMemObjectInfo to get the desired information about the memory objects.
get_pipe_info	Get information specific to an OpenCL pipe object. Calls clGetPipeInfo to get the desired information about the pipe object. CL_VERSION_2_0
get_supported_image_formats	Get the list of image formats supported by an OpenCL implementation for a specified context, image type, and allocation information. Calls clGetSupportedImageFormats to get the desired information about the program.
release_mem_object	Release an OpenCL memory object. Calls clReleaseMemObject to decrement the memory object reference count.
retain_mem_object	Retain an OpenCL memory object. Calls clRetainMemObject to increment the memory object reference count.
set_mem_object_destructor_callback	Register a callback function with an OpenCL memory object that is called when the memory object is destroyed. Calls clSetMemObjectDestructorCallback.
svm_alloc	Allocate a shared virtual memory (SVM) buffer that can be shared by the host and all devices in an OpenCL context. Calls clSVMAlloc. CL_VERSION_2_0
svm_free	Free a shared virtual memory (SVM) buffer allocated using clSVMAlloc. Calls clSVMFree. CL_VERSION_2_0