section 3clc · Library functions 📚

A

• abs(3clc)Absolute value functions. ugentype abs(gentype x); ugentype abs_diff(gentype x, gentype y);✨
• abstractDataTypes(3clc)Abstract Built-in Data Types✨
• accessQualifiers(3clc)Access Qualifiers for image memory objects. __read_only __write_only read_only write_only✨
• acos(3clc)Arc cosine functions. gentype acos(gentype ); gentype acosh(gentype ); gentype acospi(gentype x);✨
• add_sat(3clc)Add two values and saturate the result. gentype add_sat(gentype x, gentype y);✨
• any(3clc)Test for sign bit. int any(igentype x); int all(igentype x);✨
• as_typen(3clc)✨
• asin(3clc)Sine functions. gentype asin(gentype ); gentype asinh(gentype ); gentype asinpi(gentype x);✨
• async_work_group_copy(3clc)Perform an async copy. event_t async_work_group_copy(__local gentype *dst, const __global gentype *src, size_t num_gentypes, event_t event); event_t async_work_group_copy(__global gentype *dst, const…✨
• async_work_group_strided_copy(3clc)Performs an async gather of num_elements gentype elements from source to destination. event_t async_work_group_strided_copy(__local gentype *dst, const __global gentype *src, size_t num_gentypes…✨
• asyncCopyFunctions(3clc)Asynchronous copies between global and local memory and a prefetch from global memory…✨
• atan(3clc)Tangent functions. gentype atan(gentype y_over_x); gentype atan2(gentype y, gentype x); gentype atanh(gentype ); gentype atanpi(gentype x); gentype atan2pi(gentype y, gentype x);✨
• atom_add(3clc)64-bit atom_add functions. long atom_add(volatile global(3clc) long *p, long val); long atom_add(volatile global(3clc) long *p, long val); ulong atom_add(volatile local(3clc) ulong *p, ulong val)…✨
• atom_and(3clc)64-bit atom_and functions. long atom_and(volatile global(3clc) long *p, long val); long atom_and(volatile global(3clc) long *p, long val); ulong atom_and(volatile local(3clc) ulong *p, ulong val)…✨
• atom_cmpxchg(3clc)64-bit atom_cmpxchg functions. long atom_cmpxchg(volatile global(3clc) long *p, long cmp, long val); long atom_cmpxchg(volatile global(3clc) long *p, long cmp, long val); ulong atom_cmpxchg(volatile…✨
• atom_dec(3clc)64-bit atom_dec functions. long atom_dec(volatile global(3clc) long *p, long val); long atom_dec(volatile global(3clc) long *p, long val); ulong atom_dec(volatile local(3clc) ulong *p, ulong val)…✨
• atom_inc(3clc)64-bit atom_inc functions. long atom_inc(volatile global(3clc) long *p, long val); long atom_inc(volatile global(3clc) long *p, long val); ulong atom_inc(volatile local(3clc) ulong *p, ulong val)…✨
• atom_max(3clc)64-bit atom_max functions. long atom_max(volatile global(3clc) long *p, long val); long atom_max(volatile global(3clc) long *p, long val); ulong atom_max(volatile local(3clc) ulong *p, ulong val)…✨
• atom_min(3clc)64-bit atom_min functions. long atom_min(volatile global(3clc) long *p, long val); long atom_min(volatile global(3clc) long *p, long val); ulong atom_min(volatile local(3clc) ulong *p, ulong val)…✨
• atom_or(3clc)64-bit atom_or functions. long atom_or(volatile global(3clc) long *p, long val); long atom_or(volatile global(3clc) long *p, long val); ulong atom_or(volatile local(3clc) ulong *p, ulong val); ulong…✨
• atom_sub(3clc)64-bit atom_sub functions. long atom_sub(volatile global(3clc) long *p, long val); long atom_sub(volatile global(3clc) long *p, long val); ulong atom_sub(volatile local(3clc) ulong *p, ulong val)…✨
• atom_xchg(3clc)64-bit atom_xchg functions. long atom_xchg(volatile global(3clc) long *p, long val); long atom_xchg(volatile global(3clc) long *p, long val); ulong atom_xchg(volatile local(3clc) ulong *p, ulong…✨
• atom_xor(3clc)64-bit atom_xor functions. long atom_xor(volatile global(3clc) long *p, long val); long atom_xor(volatile global(3clc) long *p, long val); ulong atom_xor(volatile local(3clc) ulong *p, ulong val)…✨
• atomic_add(3clc)atomic_add functions. int atomic_add(volatile global(3clc) int *p, int val); unsigned int atomic_add(volatile global(3clc) unsigned int *p, unsigned int val); int atomic_add(volatile local(3clc) int…✨
• atomic_and(3clc)atomic_and functions. int atomic_and(volatile global(3clc) int *p, int val); unsigned int atomic_and(volatile global(3clc) unsigned int *p, unsigned int val); int atomic_and(volatile local(3clc) int…✨
• atomic_cmpxchg(3clc)atomic_cmpxchg functions. int atomic_cmpxchg(volatile global(3clc) int *p, int cmp, int val); unsigned int atomic_cmpxchg(volatile global(3clc) unsigned int *p, unsigned int cmp, unsigned int val)…✨
• atomic_dec(3clc)atomic_dec functions. int atomic_dec(volatile global(3clc) int *p); unsigned int atomic_dec(volatile global(3clc) unsigned int *p); int atomic_dec(volatile local(3clc) int *p); unsigned int…✨
• atomic_inc(3clc)atomic_inc functions. int atomic_inc(volatile global(3clc) int *p); unsigned int atomic_inc(volatile global(3clc) unsigned int *p); int atomic_inc(volatile local(3clc) int *p); unsigned int…✨
• atomic_max(3clc)atomic_max functions. int atomic_max(volatile global(3clc) int *p, int val); unsigned int atomic_max(volatile global(3clc) unsigned int *p, unsigned int val); int atomic_max(volatile local(3clc) int…✨
• atomic_min(3clc)atomic_min functions. int atomic_min(volatile global(3clc) int *p, int val); unsigned int atomic_min(volatile global(3clc) unsigned int *p, unsigned int val); int atomic_min(volatile local(3clc) int…✨
• atomic_or(3clc)atomic_or functions. int atomic_or(volatile global(3clc) int *p, int val); unsigned int atomic_or(volatile global(3clc) unsigned int *p, unsigned int val); int atomic_or(volatile local(3clc) int *p…✨
• atomic_sub(3clc)atomic_sub functions. int atomic_sub(volatile global(3clc) int *p, int val); unsigned int atomic_sub(volatile global(3clc) unsigned int *p, unsigned int val); int atomic_sub(volatile local(3clc) int…✨
• atomic_xchg(3clc)atomic_xchg functions. int atomic_xchg(volatile global(3clc) int *p, int val); unsigned int atomic_xchg(volatile global(3clc) unsigned int *p, unsigned int val); float atomic_xchg(volatile…✨
• atomic_xor(3clc)atomic_xor functions. int atomic_xor(volatile global(3clc) int *p, int val); unsigned int atomic_xor(volatile global(3clc) unsigned int *p, unsigned int val); int atomic_xor(volatile local(3clc) int…✨
• atomicFunctions(3clc)The atomic functions are shown below. Click an item in the table below for details about that function…✨
• attribute(3clc)✨
• attributes-blocksAndControlFlow(3clc)Attributes of Blocks and Control-Flow Statements. __attribute__((attr1)) {...}✨
• attributes-types(3clc)Attributes of Types. __attribute__ ((aligned)) __attribute__ ((aligned (n))) __attribute__ ((packed))✨
• attributes-variables(3clc)Attributes of Variables. __attribute__ ((aligned)) __attribute__ ((aligned (n))) __attribute__ ((packed)) __attribute__ ((endian(host))) __attribute__ ((endian(device)))✨

B

• barrier(3clc)All work-items in a work-group executing the kernel on a processor must execute this function before any are allowed to continue execution beyond the barrier. void barrier(cl_mem_fence_flags flags);✨
• bitselect(3clc)Each bit of result is corresponding bit of a if corresponding bit of c is 0. gentype bitselect(gentype a, gentype b, gentype c); halfn bitselect (halfn a, halfn b, halfn c) // if half extension…✨

C

• cbrt(3clc)Computes cube-root. gentype cbrt(gentype );✨
• ceil(3clc)Round to integer toward + infinity. gentype ceil(gentype );✨
• cl_image_format(3clc)The image format descriptor structure is defined as: typedef struct _cl_image_format { cl_channel_order image_channel_order; cl_channel_type image_channel_data_type; } cl_image_format;✨
• cl_khr_3d_image_writes(3clc)Extension to enable writes to 3D image memory objects. #pragma OPENCL EXTENSION cl_khr_3d_image_writes : enable✨
• cl_khr_d3d10_sharing(3clc)Provide interoperability between OpenCL and Direct3D 10. #pragma OPENCL EXTENSION cl_khr_d3d10_sharing : enable✨
• cl_khr_d3d11_sharing(3clc)Provide interoperability between OpenCL and Direct3D 11. #pragma OPENCL EXTENSION cl_khr_d3d11_sharing : enable✨
• cl_khr_dx9_media_sharing(3clc)Provide interoperability between OpenCL and selecgted adapter APIs (only DX9 at this time). #pragma OPENCL EXTENSION cl_khr_dx9_media_sharing : enable✨
• cl_khr_fp16(3clc)Optional half floating-point support. #pragma OPENCL EXTENSION cl_khr_fp16 : enable✨
• cl_khr_fp64(3clc)Provided for backward compatibility if double floating-point precision is supported. #pragma OPENCL EXTENSION cl_khr_fp64 : enable✨
• cl_khr_gl_event(3clc)Create an OpenCL event object from a GL sync object. cl_khr_gl_event✨
• cl_khr_gl_sharing(3clc)Allow applications to use OpenGL buffer, texture and renderbuffer objects as OpenCL memory objects. cl_khr_gl_sharing✨
• cl_khr_icd(3clc)Provide interoperability between OpenCL and Direct3D 10. #pragma OPENCL EXTENSION cl_khr_icd : enable✨
• cl_khr_int64_base_atomics(3clc)Optional extensions that implement atomic operations on 64-bit signed and unsigned integers to locations in __global and __local memory. #pragma OPENCL EXTENSION cl_khr_int64_base_atomics : enable✨
• cl_khr_int64_extended_atomics(3clc)Optional extensions that implement atomic operations on 64-bit signed and unsigned integers to locations in __global and __local memory. #pragma OPENCL EXTENSION cl_khr_int64_extended_atomics : enable✨
• clamp(3clc)Clamp x to range given by min, max gentype clamp(gentype x, gentype minval, gentype maxval); gentypef clamp(gentypef x, float minval, float maxval); gentyped clamp(gentyped x, double minval, double…✨
• classDiagram(3clc)OpenCL UML Class Diagram✨
• clBuildProgram(3clc)Builds (compiles and links) a program executable from the program source or binary. cl_int clBuildProgram(cl_program program, cl_uint num_devices, const cl_device_id *device_list, const char…✨
• clCompileProgram(3clc)Compiles a program’s source for all the devices or a specific device(s) in the OpenCL context associated with program. cl_int clCompileProgram(cl_program program, cl_uint num_devices, const…✨
• clCreateBuffer(3clc)Creates a buffer object. cl_mem clCreateBuffer(cl_context context, cl_mem_flags flags, size_t size, void *host_ptr, cl_int *errcode_ret);✨
• clCreateCommandQueue(3clc)Create a command-queue on a specific device. cl_command_queue clCreateCommandQueue(cl_context context, cl_device_id device, cl_command_queue_properties properties, cl_int *errcode_ret);✨
• clCreateContext(3clc)Creates an OpenCL context. cl_context clCreateContext(const cl_context_properties *properties, cl_uint num_devices, const cl_device_id *devices, (void CL_CALLBACK *pfn_notify) ( .sp .nf const char…✨
• clCreateContextFromType(3clc)Create an OpenCL context from a device type that identifies the specific device(s) to use. cl_context clCreateContextFromType(const cl_context_properties *properties, cl_device_type device_type, void…✨
• clCreateEventFromGLsyncKHR(3clc)Creates an event object linked to an OpenGL sync object. cl_event clCreateEventFromGLsyncKHR(cl_context context, GLsync sync, cl_int *errcode_ret);✨
• clCreateFromD3D10BufferKHR(3clc)Creates an OpenCL buffer object from a Direct3D 10 buffer. cl_mem clCreateFromD3D10BufferKHR(cl_context context, cl_mem_flags flags, ID3D10Buffer *resource, cl_int *errcode_ret);✨
• clCreateFromD3D10Texture2DKHR(3clc)Creates an OpenCL 2D image object from a subresource of a Direct3D 10 2D texture. cl_mem clCreateFromD3D10Texture2DKHR(cl_context context, cl_mem_flags flags, ID3D10Texture2D *resource, UINT…✨
• clCreateFromD3D10Texture3DKHR(3clc)Creates an OpenCL 3D image object from a subresource of a Direct3D 10 3D texture. cl_mem clCreateFromD3D10Texture3DKHR(cl_context context, cl_mem_flags flags, ID3D10Texture3D *resource, UINT…✨
• clCreateFromD3D11BufferKHR(3clc)Creates an OpenCL buffer object from a Direct3D 11 buffer. cl_mem clCreateFromD3D11BufferKHR(cl_context context, cl_mem_flags flags, ID3D11Buffer *resource, cl_int *errcode_ret);✨
• clCreateFromD3D11Texture2DKHR(3clc)Creates an OpenCL 2D image object from a subresource of a Direct3D 11 2D texture. cl_mem clCreateFromD3D11Texture2DKHR(cl_context context, cl_mem_flags flags, ID3D11Texture2D *resource, UINT…✨
• clCreateFromD3D11Texture3DKHR(3clc)Creates an OpenCL 3D image object from a subresource of a Direct3D 11 3D texture. cl_mem clCreateFromD3D11Texture3DKHR(cl_context context, cl_mem_flags flags, ID3D11Texture3D *resource, UINT…✨
• clCreateFromDX9MediaSurfaceKHR(3clc)Creates an OpenCL image object from a media surface. cl_mem clCreateFromDX9MediaSurfaceKHR(cl_context context, cl_mem_flags flags, cl_dx9_media_adapter_type_khr adapter_type, void *surface_info…✨
• clCreateFromGLBuffer(3clc)Creates an OpenCL buffer object from an OpenGL buffer object. cl_mem clCreateFromGLBuffer(cl_context context, cl_mem_flags flags, GLuint bufobj, cl_int * errcode_ret);✨
• clCreateFromGLRenderbuffer(3clc)Creates an OpenCL 2D image object from an OpenGL renderbuffer object. cl_mem clCreateFromGLRenderbuffer(cl_context context, cl_mem_flags flags, GLuint renderbuffer, cl_int * errcode_ret);✨
• clCreateFromGLTexture(3clc)Creates an OpenCL image object, image array object, or image buffer object from an OpenGL texture object, texture array object, texture buffer object, or a single face of an OpenGL cubemap texture…✨
• clCreateImage(3clc)Creates a 1D image, 1D image buffer, 1D image array, 2D image, 2D image array or 3D image object. cl_mem clCreateImage(cl_context context, cl_mem_flags flags, const cl_image_format *image_format…✨
• clCreateKernel(3clc)Creates a kernel object. cl_kernel clCreateKernel(cl_program program, const char *kernel_name, cl_int *errcode_ret);✨
• clCreateKernelsInProgram(3clc)Creates kernel objects for all kernel functions in a program object. cl_int clCreateKernelsInProgram(cl_program program, cl_uint num_kernels, cl_kernel *kernels, cl_uint *num_kernels_ret);✨
• clCreateProgramWithBinary(3clc)Creates a program object for a context, and loads the binary bits specified by binary into the program object. cl_program clCreateProgramWithBinary(cl_context context, cl_uint num_devices, const…✨
• clCreateProgramWithBuiltInKernels(3clc)Creates a program object for a context, and loads the information related to the built-in kernels into a program object. cl_program clCreateProgramWithBuiltInKernels(cl_context context, cl_uint…✨
• clCreateProgramWithSource(3clc)Creates a program object for a context, and loads the source code specified by the text strings in the strings array into the program object. cl_program clCreateProgramWithSource(cl_context context…✨
• clCreateSampler(3clc)Creates a sampler object. cl_sampler clCreateSampler(cl_context context, cl_bool normalized_coords, cl_addressing_mode addressing_mode, cl_filter_mode filter_mode, cl_int *errcode_ret);✨
• clCreateSubBuffer(3clc)Creates a new buffer object (referred to as a sub-buffer object) from an existing buffer object. cl_mem clCreateSubBuffer(cl_mem buffer, cl_mem_flags flags, cl_buffer_create_type buffer_create_type…✨
• clCreateSubDevices(3clc)Creates an array of sub-devices that each reference a non-intersecting set of compute units within in_device. cl_int clCreateSubDevices(cl_device_id in_device, const cl_device_partition_property…✨
• clCreateUserEvent(3clc)Creates a user event object. cl_event clCreateUserEvent(cl_context context, cl_int *errcode_ret);✨
• clEnqueueAcquireD3D10ObjectsKHR(3clc)Acquire OpenCL memory objects that have been created from Direct3D 10 resources cl_int clEnqueueAcquireD3D10ObjectsKHR(cl_command_queue command_queue, cl_uint num_objects, const cl_mem *mem_objects…✨
• clEnqueueAcquireD3D11ObjectsKHR(3clc)Acquire OpenCL memory objects that have been created from Direct3D 11 resources cl_int clEnqueueAcquireD3D11ObjectsKHR(cl_command_queue command_queue, cl_uint num_objects, const cl_mem *mem_objects…✨
• clEnqueueAcquireDX9MediaSurfacesKHR(3clc)Acquire OpenCL memory objects that have been created from a media surface. cl_int clEnqueueAcquireDX9MediaSurfacesKHR(cl_command_queue command_queue, cl_uint num_objects, const cl_mem *mem_objects…✨
• clEnqueueAcquireGLObjects(3clc)Acquire OpenCL memory objects that have been created from OpenGL objects. cl_int clEnqueueAcquireGLObjects(cl_command_queue command_queue, cl_uint num_objects, const cl_mem *mem_objects, cl_uint…✨
• clEnqueueBarrierWithWaitList(3clc)A synchronization point that enqueues a barrier operation. cl_int clEnqueueBarrierWithWaitList(cl_command_queue command_queue, cl_uint num_events_in_wait_list, const cl_event *event_wait_list…✨
• clEnqueueCopyBuffer(3clc)Enqueues a command to copy from one buffer object to another. cl_int clEnqueueCopyBuffer(cl_command_queue command_queue, cl_mem src_buffer, cl_mem dst_buffer, size_t src_offset, size_t dst_offset…✨
• clEnqueueCopyBufferRect(3clc)Enqueues a command to copy a rectangular region from a buffer object to another buffer object. cl_int clEnqueueCopyBufferRect(cl_command_queue command_queue, cl_mem src_buffer, cl_mem dst_buffer…✨
• clEnqueueCopyBufferToImage(3clc)Enqueues a command to copy a buffer object to an image object. cl_int clEnqueueCopyBufferToImage(cl_command_queue command_queue, cl_mem src_buffer, cl_mem dst_image, size_t src_offset, const size_t…✨
• clEnqueueCopyImage(3clc)Enqueues a command to copy image objects. cl_int clEnqueueCopyImage(cl_command_queue command_queue, cl_mem src_image, cl_mem dst_image, const size_t *src_origin, const size_t *dst_origin, const…✨
• clEnqueueCopyImageToBuffer(3clc)Enqueues a command to copy an image object to a buffer object. cl_int clEnqueueCopyImageToBuffer(cl_command_queue command_queue, cl_mem src_image, cl_mem dst_buffer, const size_t *src_origin, const…✨
• clEnqueueFillBuffer(3clc)Enqueues a command to fill a buffer object with a pattern of a given pattern size. cl_int clEnqueueFillBuffer(cl_command_queue command_queue, cl_mem buffer, const void *pattern, size_t pattern_size…✨
• clEnqueueFillImage(3clc)Enqueues a command to fill an image object with a specified color. cl_int clEnqueueFillImage(cl_command_queue command_queue, cl_mem image, const void *fill_color, const size_t *origin, const size_t…✨
• clEnqueueMapBuffer(3clc)Enqueues a command to map a region of the buffer object given by buffer into the host address space and returns a pointer to this mapped region. void * clEnqueueMapBuffer(cl_command_queue…✨
• clEnqueueMapImage(3clc)Enqueues a command to map a region of an image object into the host address space and returns a pointer to this mapped region. void * clEnqueueMapImage(cl_command_queue command_queue, cl_mem image…✨
• clEnqueueMarkerWithWaitList(3clc)Enqueues a marker command which waits for either a list of events to complete, or all previously enqueued commands to complete. cl_int clEnqueueMarkerWithWaitList(cl_command_queue command_queue…✨
• clEnqueueMigrateMemObjects(3clc)Enqueues a command to indicate which device a set of memory objects should be associated with. cl_int clEnqueueMigrateMemObjects(cl_command_queue command_queue, cl_uint num_mem_objects, const cl_mem…✨
• clEnqueueNativeKernel(3clc)Enqueues a command to execute a native C/C++ function not compiled using the OpenCL compiler. cl_int clEnqueueNativeKernel(cl_command_queue command_queue, void (*user_func)(void *), void *args…✨
• clEnqueueNDRangeKernel(3clc)Enqueues a command to execute a kernel on a device. cl_int clEnqueueNDRangeKernel(cl_command_queue command_queue, cl_kernel kernel, cl_uint work_dim, const size_t *global_work_offset, const size_t…✨
• clEnqueueReadBuffer(3clc)Enqueue commands to read from a buffer object to host memory. cl_int clEnqueueReadBuffer(cl_command_queue command_queue, cl_mem buffer, cl_bool blocking_read, size_t offset, size_t size, void *ptr…✨
• clEnqueueReadBufferRect(3clc)Enqueue commands to read from a rectangular region from a buffer object to host memory. cl_int clEnqueueReadBufferRect(cl_command_queue command_queue, cl_mem buffer, cl_bool blocking_read, const…✨
• clEnqueueReadImage(3clc)Enqueue commands to read from an image or image array object to host memory. cl_int clEnqueueReadImage(cl_command_queue command_queue, cl_mem image, cl_bool blocking_read, const size_t *origin, const…✨
• clEnqueueReleaseD3D10ObjectsKHR(3clc)Release OpenCL memory objects that have been created from Direct3D 10 resources. cl_int clEnqueueReleaseD3D10ObjectsKHR(cl_command_queue command_queue, cl_uint num_objects, const cl_mem *mem_objects…✨
• clEnqueueReleaseD3D11ObjectsKHR(3clc)Release OpenCL memory objects that have been created from Direct3D 11 resources. cl_int clEnqueueReleaseD3D11ObjectsKHR(cl_command_queue command_queue, cl_uint num_objects, const cl_mem *mem_objects…✨
• clEnqueueReleaseDX9MediaSurfacesKHR(3clc)Release OpenCL memory objects that have been created from media surfaces. cl_int clEnqueueReleaseDX9MediaSurfacesKHR(cl_command_queue command_queue, cl_uint num_objects, const cl_mem *mem_objects…✨
• clEnqueueReleaseGLObjects(3clc)Release OpenCL memory objects that have been created from OpenGL objects. cl_int clEnqueueReleaseGLObjects(cl_command_queue command_queue, cl_uint num_objects, const cl_mem *mem_objects, cl_uint…✨
• clEnqueueTask(3clc)Enqueues a command to execute a kernel on a device. cl_int clEnqueueTask(cl_command_queue command_queue, cl_kernel kernel, cl_uint num_events_in_wait_list, const cl_event *event_wait_list, cl_event…✨
• clEnqueueUnmapMemObject(3clc)Enqueues a command to unmap a previously mapped region of a memory object. cl_int clEnqueueUnmapMemObject(cl_command_queue command_queue, cl_mem memobj, void *mapped_ptr, cl_uint…✨
• clEnqueueWriteBuffer(3clc)Enqueue commands to write to a buffer object from host memory. cl_int clEnqueueWriteBuffer(cl_command_queue command_queue, cl_mem buffer, cl_bool blocking_write, size_t offset, size_t size, const…✨
• clEnqueueWriteBufferRect(3clc)Enqueue commands to write a 2D or 3D rectangular region to a buffer object from host memory. cl_int clEnqueueWriteBufferRect(cl_command_queue command_queue, cl_mem buffer, cl_bool blocking_write…✨
• clEnqueueWriteImage(3clc)Enqueues a command to write to an image or image array object from host memory. cl_int clEnqueueWriteImage(cl_command_queue command_queue, cl_mem image, cl_bool blocking_write, const size_t *origin…✨
• clFinish(3clc)Blocks until all previously queued OpenCL commands in a command-queue are issued to the associated device and have completed. cl_int clFinish(cl_command_queue command_queue);✨
• clFlush(3clc)Issues all previously queued OpenCL commands in a command-queue to the device associated with the command-queue. cl_int clFlush(cl_command_queue command_queue);✨
• clGetCommandQueueInfo(3clc)Query information about a command-queue. cl_int clGetCommandQueueInfo(cl_command_queue command_queue, cl_command_queue_info param_name, size_t param_value_size, void *param_value, size_t…✨
• clGetContextInfo(3clc)Query information about a context. cl_int clGetContextInfo(cl_context context, cl_context_info param_name, size_t param_value_size, void *param_value, size_t *param_value_size_ret);✨
• clGetDeviceIDs(3clc)Obtain the list of devices available on a platform. cl_int clGetDeviceIDs(cl_platform_id platform, cl_device_type device_type, cl_uint num_entries, cl_device_id *devices, cl_uint *num_devices);✨
• clGetDeviceIDsFromD3D10KHR(3clc)Querying OpenCL Devices Corresponding to Direct3D 10 Devices. cl_int clGetDeviceIDsFromD3D10KHR(cl_platform_id platform, cl_d3d10_device_source_khr d3d_device_source, void *d3d_object…✨
• clGetDeviceIDsFromD3D11KHR(3clc)Querying OpenCL Devices Corresponding to Direct3D 11 Devices. cl_int clGetDeviceIDsFromD3D11KHR(cl_platform_id platform, cl_d3d11_device_source_khr d3d_device_source, void *d3d_object…✨
• clGetDeviceIDsFromDX9MediaAdapterKHR(3clc)Query a media adapter for any associated OpenCL devices. cl_int clGetDeviceIDsFromDX9MediaAdapterKHR(cl_platform_id platform, cl_uint num_media_adapters, cl_dx9_media_adapter_type_khr…✨
• clGetDeviceInfo(3clc)Get information about an OpenCL device. cl_int clGetDeviceInfo(cl_device_id device, cl_device_info param_name, size_t param_value_size, void *param_value, size_t *param_value_size_ret);✨
• clGetEventInfo(3clc)Returns information about the event object. cl_int clGetEventInfo(cl_event event, cl_event_info param_name, size_t param_value_size, void *param_value, size_t *param_value_size_ret);✨
• clGetEventProfilingInfo(3clc)Returns profiling information for the command associated with event if profiling is enabled. cl_int clGetEventProfilingInfo(cl_event event, cl_profiling_info param_name, size_t param_value_size, void…✨
• clGetExtensionFunctionAddressForPlatform(3clc)Returns the address of the extension function named by funcname for a given platform. void* clGetExtensionFunctionAddressForPlatform(cl_platform_id platform, const char *funcname);✨
• clGetGLContextInfoKHR(3clc)Get OpenGL context information. cl_int clGetGLContextInfoKHR(const cl_context_properties *properties, cl_gl_context_info param_name, size_t param_value_size, void *param_value, size_t…✨
• clGetGLObjectInfo(3clc)Query an OpenGL memory object used to create an OpenCL memory object. cl_int clGetGLObjectInfo(cl_mem memobj, cl_gl_object_type *gl_object_type, GLuint *gl_object_name);✨
• clGetGLTextureInfo(3clc)Returns additional information about the GL texture object associated with a memory object. cl_int clGetGLTextureInfo(cl_mem memobj, cl_gl_texture_info param_name, size_t param_value_size, void…✨
• clGetImageInfo(3clc)Get information specific to an image object created with clCreateImage. cl_intclGetImageInfo(cl_mem image, cl_image_info param_name, size_t param_value_size, void *param_value, size_t…✨
• clGetKernelArgInfo(3clc)Returns information about the arguments of a kernel. cl_int clGetKernelArgInfo(cl_kernel kernel, cl_uint arg_indx, cl_kernel_arg_info param_name, size_t param_value_size, void *param_value, size_t…✨
• clGetKernelInfo(3clc)Returns information about the kernel object. cl_int clGetKernelInfo(cl_kernel kernel, cl_kernel_info param_name, size_t param_value_size, void *param_value, size_t *param_value_size_ret);✨
• clGetKernelWorkGroupInfo(3clc)Returns information about the kernel object that may be specific to a device. cl_int clGetKernelWorkGroupInfo(cl_kernel kernel, cl_device_id device, cl_kernel_work_group_info param_name, size_t…✨
• clGetMemObjectInfo(3clc)Get information that is common to all memory objects (buffer and image objects). cl_int clGetMemObjectInfo(cl_mem memobj, cl_mem_info param_name, size_t param_value_size, void *param_value, size_t…✨
• clGetPlatformIDs(3clc)Obtain the list of platforms available. cl_int clGetPlatformIDs(cl_uint num_entries, cl_platform_id *platforms, cl_uint *num_platforms);✨
• clGetPlatformInfo(3clc)Get specific information about the OpenCL platform. cl_int clGetPlatformInfo(cl_platform_id platform, cl_platform_info param_name, size_t param_value_size, void *param_value, size_t…✨
• clGetProgramBuildInfo(3clc)Returns build information for each device in the program object. cl_int clGetProgramBuildInfo(cl_program program, cl_device_id device, cl_program_build_info param_name, size_t param_value_size, void…✨
• clGetProgramInfo(3clc)Returns information about the program object. cl_int clGetProgramInfo(cl_program program, cl_program_info param_name, size_t param_value_size, void *param_value, size_t *param_value_size_ret);✨
• clGetSamplerInfo(3clc)Returns information about the sampler object. cl_int clGetSamplerInfo(cl_sampler sampler, cl_sampler_info param_name, size_t param_value_size, void *param_value, size_t *param_value_size_ret);✨
• clGetSupportedImageFormats(3clc)Get the list of image formats supported by an OpenCL implementation. cl_int clGetSupportedImageFormats(cl_context context, cl_mem_flags flags, cl_mem_object_type image_type, cl_uint num_entries…✨
• clIcdGetPlatformIDsKHR(3clc)Obtain the list of platforms accessible through the Khronos ICD Loader. cl_int clIcdGetPlatformIDsKHR(cl_uint num_entries, cl_platform_id *platforms, cl_uint *num_platforms);✨
• clLinkProgram(3clc)Links a set of compiled program objects and libraries for all the devices or a specific device(s) in the OpenCL context and creates an executable. cl_program clLinkProgram(cl_context context, cl_uint…✨
• clReleaseCommandQueue(3clc)Decrements the command_queue reference count. cl_int clReleaseCommandQueue(cl_command_queue command_queue);✨
• clReleaseContext(3clc)Decrement the context reference count. cl_int clReleaseContext(cl_context context);✨
• clReleaseDevice(3clc)Decrements the device reference count. cl_int clReleaseDevice(cl_device_id device);✨
• clReleaseEvent(3clc)Decrements the event reference count. cl_int clReleaseEvent(cl_event event);✨
• clReleaseKernel(3clc)Decrements the kernel reference count. cl_int clReleaseKernel(cl_kernel kernel);✨
• clReleaseMemObject(3clc)Decrements the memory object reference count. cl_int clReleaseMemObject(cl_mem memobj);✨
• clReleaseProgram(3clc)Decrements the program reference count. cl_int clReleaseProgram(cl_program program);✨
• clReleaseSampler(3clc)Decrements the sampler reference count. cl_int clReleaseSampler(cl_sampler sampler);✨
• clRetainCommandQueue(3clc)Increments the command_queue reference count. cl_int clRetainCommandQueue(cl_command_queue command_queue);✨
• clRetainContext(3clc)Increment the context reference count. cl_int clRetainContext(cl_context context);✨
• clRetainDevice(3clc)Increments the devices reference count. cl_int clRetainDevice(cl_device_id device);✨
• clRetainEvent(3clc)Increments the event reference count. cl_int clRetainEvent(cl_event event);✨
• clRetainKernel(3clc)Increments the kernel object reference count. cl_int clRetainKernel(cl_kernel kernel);✨
• clRetainMemObject(3clc)Increments the memory object reference count. cl_int clRetainMemObject(cl_mem memobj);✨
• clRetainProgram(3clc)Increments the program reference count. cl_int clRetainProgram(cl_program program);✨
• clRetainSampler(3clc)Increments the sampler reference count. cl_int clRetainSampler(cl_sampler sampler);✨
• clSetEventCallback(3clc)Registers a user callback function for a specific command execution status. cl_int clSetEventCallback(cl_event event, cl_int command_exec_callback_type, void (CL_CALLBACK *pfn_event_notify) (cl_event…✨
• clSetKernelArg(3clc)Used to set the argument value for a specific argument of a kernel. cl_int clSetKernelArg(cl_kernel kernel, cl_uint arg_index, size_t arg_size, const void *arg_value);✨
• clSetMemObjectDestructorCallback(3clc)Registers a user callback function with a memory object. cl_int clSetMemObjectDestructorCallback(cl_mem memobj, void (CL_CALLBACK *pfn_notify) (cl_mem memobj, void *user_data), void *user_data);✨
• clSetUserEventStatus(3clc)Sets the execution status of a user event object. cl_int clSetUserEventStatus(cl_event event, cl_int execution_status);✨
• clUnloadPlatformCompiler(3clc)Allows the implementation to release the resources allocated by the OpenCL compiler for platform. cl_int clUnloadPlatformCompiler(cl_platform_id platform);✨
• clWaitForEvents(3clc)Waits on the host thread for commands identified by event objects to complete. cl_int clWaitForEvents(cl_uint num_events, const cl_event *event_list);✨
• clz(3clc)Returns the number of leading 0-bits in x. gentype clz(gentype x);✨
• commonFunctions(3clc)Click an item in the table below for details about that function…✨
• commonMax(3clc)Returns the greater of two values. gentype max(gentype x, gentype y); gentypef max(gentypef x, float y); gentyped max(gentyped x, double y); gentype max (gentype x, half y) // if half extension…✨
• commonMin(3clc)Returns the lesser of two values. gentype min(gentype x, gentype y); gentypef min(gentypef x, float y); gentyped min(gentyped x, double y); gentype min (gentype x, half y) // if half extension enabled✨
• constant(3clc)Address Space Qualifier. __constant constant✨
• convert_T(3clc)Explicit type conversions using convert_T() convert_destType(sourceType) destType convert_destType<_sat><roundingMode> (sourceType) destTypen convert_destTypen<_sat><roundingMode> (sourceType)✨
• copysign(3clc)x with sign changed to sign of y. gentype copysign(gentype x, gentype y);✨
• cos(3clc)Cosine functions. gentype cos(gentype ); gentype cosh(gentype ); gentype cospi(gentype x); gentype half_cos(gentype x); gentype native_cos(gentype x);✨
• cross(3clc)Cross product. float4 cross(float4 p0, float4 p1); float3 cross(float3 p0, float3 p1); double4 cross(double4 p0, double4 p1); double3 cross(double3 p0, double3 p1); half4 cross (half4 p0, half4 p1)…✨

D

• dataTypes(3clc)OpenCL data types.✨
• degrees(3clc)Converts radians to degrees. gentype degrees(gentype radians);✨
• deprecated(3clc)✨
• distance(3clc)Vector distance. float distance(floatn p0, floatn p1); double distance(doublen p0, doublen p1); half distance (gentype p0, gentype p1) // if half extension enabled✨
• divide(3clc)Division functions. gentype half_divide(gentype x, gentype y); gentype native_divide(gentype x, gentype y);✨
• dot(3clc)Dot product. float dot(floatn p0, floatn p1); double dot(doublen p0, doublen p1); half dot (gentype p0, gentype p1) // if half extension enabled✨

E

• enums(3clc)Following are the enumerated types and their permitted values…✨
• erf(3clc)Error functions. gentype erf(gentype ); gentype erfc(gentype );✨
• exp(3clc)Exponent functions. gentype exp(gentype x); gentype exp2(gentype ); gentype exp10(gentype ); gentype expm1(gentype x); gentype half_exp(gentype x); gentype half_exp2(gentype x); gentype…✨
• explicitMemoryFenceFunctions(3clc)Click an item in the table below for details about that function…✨
• EXTENSION(3clc)A #pragma directive to set the behavior for OpenCL extensions. #pragma OPENCL EXTENSION extension_name : behavior #pragma OPENCL EXTENSION all : behavior✨

F

• fabs(3clc)Compute absolute value of a floating-point number. gentype fabs(gentype );✨
• fast_distance(3clc)Vector distance. float fast_distance(floatn p0, floatn p1);✨
• fast_length(3clc)Vector length. float fast_length(floatn p);✨
• fast_normalize(3clc)Normal vector length 1. floatn fast_normalize(floatn p);✨
• fdim(3clc)Positive difference between x and y. gentype fdim(gentype x, gentype y);✨
• floor(3clc)Round to integer toward negative infinity. gentype floor(gentype );✨
• fma(3clc)Multiply and add, then round. gentype fma(gentype a, gentype b, gentype c);✨
• fmax(3clc)Returns the greater of either x or y. gentype fmax(gentype x, gentype y); gentypef fmax(gentypef x, float y); gentyped fmax(gentyped x, double y); gentype fmax (gentype x, half y) // if half…✨
• fmin(3clc)Returns the lessor of either x or y. gentype fmin(gentype x, gentype y); gentypef fmin(gentypef x, float y); gentyped fmin(gentyped x, double y); gentype fmin (gentype x, half y) // if half extension…✨
• fmod(3clc)Modulus. Returns x - y * trunc (x/y). gentype fmod(gentype x, gentype y);✨
• FP_CONTRACT(3clc)Control expression contraction; fast fma()✨
• fract(3clc)Fractional value in x. gentype fract(gentype x, __global gentype *itpr); gentype fract(gentype x, __local gentype *itpr); gentype fract(gentype x, __private gentype *itpr);✨
• frexp(3clc)Extract mantissa and exponent. floatn frexp(floatn x, __global intn *exp); floatn frexp(floatn x, __local intn *exp); floatn frexp(floatn x, __private intn *exp); float frexp(float x, __global int…✨
• functionQualifiers(3clc)Qualifiers for kernel functions. __kernel kernel __attribute__((vec_type_hint(<typen>))) __attribute__((work_group_size_hint(X, Y, Z))) __attribute__((reqd_work_group_size(X, Y, Z)))✨

G

• geometricFunctions(3clc)Click an item in the table below for details about that function…✨
• get_global_id(3clc)Returns the unique global work-item ID value for dimension identified by dimindx. size_t get_global_id(uint dimindx);✨