pragmatism first

Manual pages

Scope: OpenCL Manual.

[ Alias ↣ ] Name (section) Brief
abs(3clc) Absolute value functions.
abstractDataTypes(3clc) Abstract Built-in Data Types.
accessQualifiers(3clc) Access Qualifiers for image memory objects.
acos(3clc) Arc cosine functions.
add_sat(3clc) Add two values and saturate the result.
any(3clc) Test for sign bit.
as_typen(3clc)
asin(3clc) Sine functions.
async_work_group_copy(3clc) Perform an async copy.
async_work_group_strided_copy(3clc) Performs an async gather of num_elements gentype elements from source to.
asyncCopyFunctions(3clc) Asynchronous copies between global and local memory and a prefetch from.
atan(3clc) Tangent functions.
atom_add(3clc) 64-bit atom_add functions.
atom_and(3clc) 64-bit atom_and functions.
atom_cmpxchg(3clc) 64-bit atom_cmpxchg functions.
atom_dec(3clc) 64-bit atom_dec functions.
atom_inc(3clc) 64-bit atom_inc functions.
atom_max(3clc) 64-bit atom_max functions.
atom_min(3clc) 64-bit atom_min functions.
atom_or(3clc) 64-bit atom_or functions.
atom_sub(3clc) 64-bit atom_sub functions.
atom_xchg(3clc) 64-bit atom_xchg functions.
atom_xor(3clc) 64-bit atom_xor functions.
atomic_add(3clc) Atomic_add functions.
atomic_and(3clc) Atomic_and functions.
atomic_cmpxchg(3clc) Atomic_cmpxchg functions.
atomic_dec(3clc) Atomic_dec functions.
atomic_inc(3clc) Atomic_inc functions.
atomic_max(3clc) Atomic_max functions.
atomic_min(3clc) Atomic_min functions.
atomic_or(3clc) Atomic_or functions.
atomic_sub(3clc) Atomic_sub functions.
atomic_xchg(3clc) Atomic_xchg functions.
atomic_xor(3clc) Atomic_xor functions.
atomicFunctions(3clc) The atomic functions are shown below. Click an item in the table below for details about.
attribute(3clc)
attributes-blocksAndControlFlow(3clc) Attributes of Blocks and Control-Flow Statements.
attributes-types(3clc) Attributes of Types.
attributes-variables(3clc) Attributes of Variables.
barrier(3clc) All work-items in a work-group executing the kernel on a processor must execute this function before.
bitselect(3clc) Each bit of result is corresponding bit of a if corresponding bit of c is 0.
cbrt(3clc) Computes cube-root.
ceil(3clc) Round to integer toward + infinity.
cl_image_format(3clc) The image format descriptor structure is defined as:.
cl_khr_3d_image_writes(3clc) Extension to enable writes to 3D image memory objects.
cl_khr_d3d10_sharing(3clc) Provide interoperability between OpenCL and Direct3D 10.
cl_khr_d3d11_sharing(3clc) Provide interoperability between OpenCL and Direct3D 11.
cl_khr_dx9_media_sharing(3clc) Provide interoperability between OpenCL and selecgted adapter APIs (only DX9 at.
cl_khr_fp16(3clc) Optional half floating-point support.
cl_khr_fp64(3clc) Provided for backward compatibility if double floating-point precision is supported.
cl_khr_gl_event(3clc) Create an OpenCL event object from a GL sync object.
cl_khr_gl_sharing(3clc) Allow applications to use OpenGL buffer, texture and renderbuffer objects as OpenCL memory.
cl_khr_icd(3clc) Provide interoperability between OpenCL and Direct3D 10.
cl_khr_int64_base_atomics(3clc) Optional extensions that implement atomic operations on 64-bit signed and unsigned.
cl_khr_int64_extended_atomics(3clc) Optional extensions that implement atomic operations on 64-bit signed and.
clamp(3clc) Clamp x to range given by min, max.
classDiagram(3clc) OpenCL UML Class Diagram.
clBuildProgram(3clc) Builds (compiles and links) a program executable from the program source or binary.
clCompileProgram(3clc) Compiles a program’s source for all the devices or a specific device(s) in the OpenCL.
clCreateBuffer(3clc) Creates a buffer object.
clCreateCommandQueue(3clc) Create a command-queue on a specific device.
clCreateContext(3clc) Creates an OpenCL context.
clCreateContextFromType(3clc) Create an OpenCL context from a device type that identifies the specific device(s).
clCreateEventFromGLsyncKHR(3clc) Creates an event object linked to an OpenGL sync object.
clCreateFromD3D10BufferKHR(3clc) Creates an OpenCL buffer object from a Direct3D 10 buffer.
clCreateFromD3D10Texture2DKHR(3clc) Creates an OpenCL 2D image object from a subresource of a Direct3D 10 2D.
clCreateFromD3D10Texture3DKHR(3clc) Creates an OpenCL 3D image object from a subresource of a Direct3D 10 3D.
clCreateFromD3D11BufferKHR(3clc) Creates an OpenCL buffer object from a Direct3D 11 buffer.
clCreateFromD3D11Texture2DKHR(3clc) Creates an OpenCL 2D image object from a subresource of a Direct3D 11 2D.
clCreateFromD3D11Texture3DKHR(3clc) Creates an OpenCL 3D image object from a subresource of a Direct3D 11 3D.
clCreateFromDX9MediaSurfaceKHR(3clc) Creates an OpenCL image object from a media surface.
clCreateFromGLBuffer(3clc) Creates an OpenCL buffer object from an OpenGL buffer object.
clCreateFromGLRenderbuffer(3clc) Creates an OpenCL 2D image object from an OpenGL renderbuffer object.
clCreateFromGLTexture(3clc) Creates an OpenCL image object, image array object, or image buffer object from an.
clCreateImage(3clc) Creates a 1D image, 1D image buffer, 1D image array, 2D image, 2D image array or 3D image.
clCreateKernel(3clc) Creates a kernel object.
clCreateKernelsInProgram(3clc) Creates kernel objects for all kernel functions in a program object.
clCreateProgramWithBinary(3clc) Creates a program object for a context, and loads the binary bits specified by.
clCreateProgramWithBuiltInKernels(3clc) Creates a program object for a context, and loads the information related.
clCreateProgramWithSource(3clc) Creates a program object for a context, and loads the source code specified by the.
clCreateSampler(3clc) Creates a sampler object.
clCreateSubBuffer(3clc) Creates a new buffer object (referred to as a sub-buffer object) from an existing buffer.
clCreateSubDevices(3clc) Creates an array of sub-devices that each reference a non-intersecting set of compute.
clCreateUserEvent(3clc) Creates a user event object.
clEnqueueAcquireD3D10ObjectsKHR(3clc) Acquire OpenCL memory objects that have been created from Direct3D 10.
clEnqueueAcquireD3D11ObjectsKHR(3clc) Acquire OpenCL memory objects that have been created from Direct3D 11.
clEnqueueAcquireDX9MediaSurfacesKHR(3clc) Acquire OpenCL memory objects that have been created from a media.
clEnqueueAcquireGLObjects(3clc) Acquire OpenCL memory objects that have been created from OpenGL objects.
clEnqueueBarrierWithWaitList(3clc) A synchronization point that enqueues a barrier operation.
clEnqueueCopyBuffer(3clc) Enqueues a command to copy from one buffer object to another.
clEnqueueCopyBufferRect(3clc) Enqueues a command to copy a rectangular region from a buffer object to another.
clEnqueueCopyBufferToImage(3clc) Enqueues a command to copy a buffer object to an image object.
clEnqueueCopyImage(3clc) Enqueues a command to copy image objects.
clEnqueueCopyImageToBuffer(3clc) Enqueues a command to copy an image object to a buffer object.
clEnqueueFillBuffer(3clc) Enqueues a command to fill a buffer object with a pattern of a given pattern size.
clEnqueueFillImage(3clc) Enqueues a command to fill an image object with a specified color.
clEnqueueMapBuffer(3clc) Enqueues a command to map a region of the buffer object given by buffer into the host.
clEnqueueMapImage(3clc) Enqueues a command to map a region of an image object into the host address space and.
clEnqueueMarkerWithWaitList(3clc) Enqueues a marker command which waits for either a list of events to complete,.
clEnqueueMigrateMemObjects(3clc) Enqueues a command to indicate which device a set of memory objects should be.
clEnqueueNativeKernel(3clc) Enqueues a command to execute a native C/C++ function not compiled using the OpenCL.
clEnqueueNDRangeKernel(3clc) Enqueues a command to execute a kernel on a device.
clEnqueueReadBuffer(3clc) Enqueue commands to read from a buffer object to host memory.
clEnqueueReadBufferRect(3clc) Enqueue commands to read from a rectangular region from a buffer object to host.
clEnqueueReadImage(3clc) Enqueue commands to read from an image or image array object to host memory.
clEnqueueReleaseD3D10ObjectsKHR(3clc) Release OpenCL memory objects that have been created from Direct3D 10.
clEnqueueReleaseD3D11ObjectsKHR(3clc) Release OpenCL memory objects that have been created from Direct3D 11.
clEnqueueReleaseDX9MediaSurfacesKHR(3clc) Release OpenCL memory objects that have been created from media.
clEnqueueReleaseGLObjects(3clc) Release OpenCL memory objects that have been created from OpenGL objects.
clEnqueueTask(3clc) Enqueues a command to execute a kernel on a device.
clEnqueueUnmapMemObject(3clc) Enqueues a command to unmap a previously mapped region of a memory object.
clEnqueueWriteBuffer(3clc) Enqueue commands to write to a buffer object from host memory.
clEnqueueWriteBufferRect(3clc) Enqueue commands to write a 2D or 3D rectangular region to a buffer object from.
clEnqueueWriteImage(3clc) Enqueues a command to write to an image or image array object from host memory.
clFinish(3clc) Blocks until all previously queued OpenCL commands in a command-queue are issued to the associated.
clFlush(3clc) Issues all previously queued OpenCL commands in a command-queue to the device associated with the.
clGetCommandQueueInfo(3clc) Query information about a command-queue.
clGetContextInfo(3clc) Query information about a context.
clGetDeviceIDs(3clc) Obtain the list of devices available on a platform.
clGetDeviceIDsFromD3D10KHR(3clc) Querying OpenCL Devices Corresponding to Direct3D 10 Devices.
clGetDeviceIDsFromD3D11KHR(3clc) Querying OpenCL Devices Corresponding to Direct3D 11 Devices.
clGetDeviceIDsFromDX9MediaAdapterKHR(3clc) Query a media adapter for any associated OpenCL devices.
clGetDeviceInfo(3clc) Get information about an OpenCL device.
clGetEventInfo(3clc) Returns information about the event object.
clGetEventProfilingInfo(3clc) Returns profiling information for the command associated with event if profiling is.
clGetExtensionFunctionAddressForPlatform(3clc) Returns the address of the extension function named by funcname for.
clGetGLContextInfoKHR(3clc) Get OpenGL context information.
clGetGLObjectInfo(3clc) Query an OpenGL memory object used to create an OpenCL memory object.
clGetGLTextureInfo(3clc) Returns additional information about the GL texture object associated with a memory.
clGetImageInfo(3clc) Get information specific to an image object created with clCreateImage.
clGetKernelArgInfo(3clc) Returns information about the arguments of a kernel.
clGetKernelInfo(3clc) Returns information about the kernel object.
clGetKernelWorkGroupInfo(3clc) Returns information about the kernel object that may be specific to a device.
clGetMemObjectInfo(3clc) Get information that is common to all memory objects (buffer and image objects).
clGetPlatformIDs(3clc) Obtain the list of platforms available.
clGetPlatformInfo(3clc) Get specific information about the OpenCL platform.
clGetProgramBuildInfo(3clc) Returns build information for each device in the program object.
clGetProgramInfo(3clc) Returns information about the program object.
clGetSamplerInfo(3clc) Returns information about the sampler object.
clGetSupportedImageFormats(3clc) Get the list of image formats supported by an OpenCL implementation.
clIcdGetPlatformIDsKHR(3clc) Obtain the list of platforms accessible through the Khronos ICD Loader.
clLinkProgram(3clc) Links a set of compiled program objects and libraries for all the devices or a specific.
clReleaseCommandQueue(3clc) Decrements the command_queue reference count.
clReleaseContext(3clc) Decrement the context reference count.
clReleaseDevice(3clc) Decrements the device reference count.
clReleaseEvent(3clc) Decrements the event reference count.
clReleaseKernel(3clc) Decrements the kernel reference count.
clReleaseMemObject(3clc) Decrements the memory object reference count.
clReleaseProgram(3clc) Decrements the program reference count.
clReleaseSampler(3clc) Decrements the sampler reference count.
clRetainCommandQueue(3clc) Increments the command_queue reference count.
clRetainContext(3clc) Increment the context reference count.
clRetainDevice(3clc) Increments the devices reference count.
clRetainEvent(3clc) Increments the event reference count.
clRetainKernel(3clc) Increments the kernel object reference count.
clRetainMemObject(3clc) Increments the memory object reference count.
clRetainProgram(3clc) Increments the program reference count.
clRetainSampler(3clc) Increments the sampler reference count.
clSetEventCallback(3clc) Registers a user callback function for a specific command execution status.
clSetKernelArg(3clc) Used to set the argument value for a specific argument of a kernel.
clSetMemObjectDestructorCallback(3clc) Registers a user callback function with a memory object.
clSetUserEventStatus(3clc) Sets the execution status of a user event object.
clUnloadPlatformCompiler(3clc) Allows the implementation to release the resources allocated by the OpenCL compiler.
clWaitForEvents(3clc) Waits on the host thread for commands identified by event objects to complete.
clz(3clc) Returns the number of leading 0-bits in x.
commonFunctions(3clc) Click an item in the table below for details about that function.
commonMax(3clc) Returns the greater of two values.
commonMin(3clc) Returns the lesser of two values.
constant(3clc) Address Space Qualifier.
convert_T(3clc) Explicit type conversions using convert_T().
copysign(3clc) X with sign changed to sign of y.
cos(3clc) Cosine functions.
cross(3clc) Cross product.
dataTypes(3clc) OpenCL data types.
degrees(3clc) Converts radians to degrees.
deprecated(3clc)
distance(3clc) Vector distance.
divide(3clc) Division functions.
dot(3clc) Dot product.
enums(3clc) Following are the enumerated types and their permitted values.
erf(3clc) Error functions.
exp(3clc) Exponent functions.
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.
fabs(3clc) Compute absolute value of a floating-point number.
fast_distance(3clc) Vector distance.
fast_length(3clc) Vector length.
fast_normalize(3clc) Normal vector length 1.
fdim(3clc) Positive difference between x and y.
floor(3clc) Round to integer toward negative infinity.
fma(3clc) Multiply and add, then round.
fmax(3clc) Returns the greater of either x or y.
fmin(3clc) Returns the lessor of either x or y.
fmod(3clc) Modulus. Returns x - y * trunc (x/y).
FP_CONTRACT(3clc) Control expression contraction; fast fma().
fract(3clc) Fractional value in x.
frexp(3clc) Extract mantissa and exponent.
functionQualifiers(3clc) Qualifiers for kernel functions.
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.
get_global_offset(3clc) Returns the offset values specified in global_work_offset argument to.
get_global_size(3clc) Returns the number of global work-items specified for dimension identified by dimindx.
get_group_id(3clc) Returns the work-group ID.
get_image_array_size(3clc) Return the number of images in an image array.
get_image_channel_data_type(3clc) Return the channel data type.
get_image_channel_order(3clc) Return the image channel data order.
get_image_depth(3clc) Return the 3D image depth in pixels.
get_image_dim(3clc) Return the image dimensions.
get_image_height(3clc) Return the image height in pixels.
get_image_width(3clc) Return the image width in pixels.
get_local_id(3clc) Returns the unique local work-item ID.
get_local_size(3clc) Returns the number of local work-items.
get_num_groups(3clc) Returns the number of work-groups that will execute a kernel.
get_work_dim(3clc) Returns the number of dimensions in use.
global(3clc) Address space qualifier.
hadd(3clc) Returns (x + y) >> 1, or (x + y + 1) >> 1.
hypot(3clc) Square root of x2 + y2.
ilogb(3clc) Exponent as an integer value.
imageDescriptor(3clc) The image descriptor structure describes the type and dimensions of the image or image array.
imageFunctions(3clc) Built-in functions to read, write, and query image memory objects. Click an.
integerClamp(3clc) Clamp x to range given by minval, maxval.
integerFunctions(3clc) Click an item in the table below for details about that function.
integerMax(3clc) Returns the greater or lesser of x or y.
isequal(3clc) Compare of x == y.
isfinite(3clc) Test for finite value.
isgreater(3clc) Compare of x > y.
isgreaterequal(3clc) Compare of x >= y.
isinf(3clc) Test for infinity value.
isless(3clc) Compare of x < y.
islessequal(3clc) Compare of x.
islessgreater(3clc) Compare of (x < y) || (x > y).
isnan(3clc) Test for a NaN.
isnormal(3clc) Test for a normal value.
isnotequal(3clc) Compare of x != y.
isordered(3clc) Test if arguments are ordered.
isunordered(3clc) Test if arguments are unordered.
ldexp(3clc) Multiply x by 2 to the power k.
length(3clc) Vector length.
lgamma(3clc) Log gamma functions.
local(3clc) Address Space Qualifier.
log(3clc) Logarithm functions.
macroLimits(3clc) Macros for math limits.
mad(3clc) Approximates a * b + c.
mad24(3clc) Fast integer function to multiply 24-bit integers and add a 32-bit value.
mad_hi(3clc) Returns mul_hi(a, b) + c.
mad_sat(3clc) Returns a*b+c and saturates the result.
mag(3clc) Returns the argument with the greatest (or least) magnitude.
mathConstants(3clc) The following symbolic constants are available.
mathFunctions(3clc) The table below describes the list of built-in math functions. These functions can.
mem_fence(3clc) Orders loads and stores of a work-item executing a kernel.
miscVectorFunctions(3clc) The table below describes the list of built-in miscelaneous vector functions.
mix(3clc) Linear blend of x and y.
modf(3clc) Decompose a floating-point number.
mul24(3clc) Fast integer function to multiply 24-bit integer values.
mul_hi(3clc) Returns the high half of the product of x and y.
nan(3clc) Quiet NaN.
nextafter(3clc) Next representable floating-point value following x in the direction of y.
normalize(3clc) Normal vector length 1.
operators(3clc) Operators used in OpenCL.
otherDataTypes(3clc) Other Built-in Data Types.
popcount(3clc) Returns the number of non-zero bits in x.
pow(3clc) Compute x to the power of y.
prefetch(3clc) Prefetch bytes into the global cache.
preprocessorDirectives(3clc) Preprocessor Directives and Macros.
printfFunction(3clc) The OpenCL C programming language implements the printf function.
private(3clc) Address Space Qualifier.
qualifiers(3clc) OpenCL qualifiers.
radians(3clc) Converts degrees to radians.
read_imagef1d(3clc) Do an element lookup in the 1D image object, returning floating-point values.
read_imagef2d(3clc) Do an element lookup in the 2D image object, returning floating-point values.
read_imagef3d(3clc) Do an element lookup in the 3D image object, returning floating-point values.
read_imageh1d(3clc) Do an element lookup in the 1D image object, returning half floating-point values.
read_imageh2d(3clc) Do an element lookup in the 2D image object, returning half floating-point values.
read_imageh3d(3clc) Do an element lookup in the 3D image object, returning half floating-point values.
read_imagei1d(3clc) Do an element lookup in the 1D image object, returning unnormalized signed integer and.
read_imagei2d(3clc) Do an element lookup in the 2D image object, returning unnormalized signed integer and.
read_imagei3d(3clc) Do an element lookup in the 3D image object, returning unnormalized signed integer and.
read_mem_fence(3clc) Read memory barrier that orders only loads.
recip(3clc) Floating point reciprocal.
relationalFunctions(3clc) Click an item in the table below for details about that function.
remainder(3clc) Floating point remainder function.
remquo(3clc) Floating point remainder and quotient function.
reservedDataTypes(3clc) Built-in reserved Data Types.
restrictions(3clc)
rint(3clc) Round to nearest even integer.
rootn(3clc) Compute x to the power 1/y.
rotate(3clc) Rotate bits left.
round(3clc) Rounding function.
sampler_t(3clc) A type used to control how elements of an image object are read by read_image{f|i|ui}.
scalarDataTypes(3clc) Built-in scalar data types.
select(3clc) For each component of a vector type, result[i] = if MSB of c[i] is set ? b[i] : a[i]. For scalar.
shuffle(3clc) Constructs a permutation of elements from one (or two) input vectors.
sign(3clc) Sign of a value.
signbit(3clc) Test for sign bit.
sin(3clc) Sine functions.
smoothstep(3clc) Step and interpolate.
sqrt(3clc) Square root functions.
step(3clc) Returns 0.0 if x < edge, else 1.0.
storageQualifiers(3clc) The typedef, extern and static storage-class specifiers.
sub_sat(3clc) Returns x - y and saturates the result.
supportedImageFormats(3clc) Supported Image Formats.
tan(3clc) Tangent functions.
tgamma(3clc) Gamma function.
trunc(3clc) Round to integer toward zero.
upsample(3clc) Result[i] = ((gentype)hi[i].
vec_step(3clc) Takes a built-in scalar or vector data type argument and returns an integer value representing the.
vectorDataLoadandStoreFunctions(3clc) Click an item in the table below for details about that function.
vectorDataTypes(3clc) Built-in vector data types.
vload_half(3clc) Read a half float from a pointer to memory.
vload_halfn(3clc) Read a half float vector from a pointer to memory.
vloada_halfn(3clc) Read half float vector from a pointer to memory.
vloadn(3clc) Read vectors from a pointer to memory.
vstore_half(3clc) Convert float to half and write to a pointer to memory.
vstore_halfn(3clc) Convert float vector to half vector and write to a pointer to memory.
vstorea_halfn(3clc) Convert float vector to half vector and write to a pointer to memory.
vstoren(3clc) Write sizeof bytes (gentypen) to memory.
wait_group_events(3clc) Wait for events that identify the async_work_group_copy operations to complete.
workItemFunctions(3clc) Click an item in the table below for details about that function.
write_image1d(3clc) Write color value to location in a 1D image object.
write_image2d(3clc) Write color value to location in a 2D image object.
write_image3d(3clc) Write color value to location in a 3D image object.
write_mem_fence(3clc) Write memory barrier that orders only stores.
Go top Index Scopes