Show / Hide Table of Contents

Class CL

Inheritance
object
CLBase
CL
Inherited Members
CLBase.RegisterOpenCLResolver()
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: OpenTK.Compute.OpenCL
Assembly: OpenTK.Compute.dll
Syntax
public class CL : CLBase

Methods

BuildProgram(CLProgram, CLDevice[], string, ClEventCallback)

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode BuildProgram(CLProgram program, CLDevice[] deviceList, string options, CL.ClEventCallback callback)
Parameters
Type Name Description
CLProgram program
CLDevice[] deviceList
string options
CL.ClEventCallback callback
Returns
Type Description
CLResultCode

BuildProgram(CLProgram, uint, CLDevice[], string, nint, nint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode BuildProgram(CLProgram program, uint numberOfDevices, CLDevice[] deviceList, string options, nint notificationCallback, nint userData)
Parameters
Type Name Description
CLProgram program
uint numberOfDevices
CLDevice[] deviceList
string options
nint notificationCallback
nint userData
Returns
Type Description
CLResultCode

CloneKernel(CLKernel, out CLResultCode)

Introduced in OpenCL 2.1.

Declaration
public static extern CLKernel CloneKernel(CLKernel sourceKernel, out CLResultCode resultCode)
Parameters
Type Name Description
CLKernel sourceKernel
CLResultCode resultCode
Returns
Type Description
CLKernel

CompileProgram(CLProgram, uint, CLDevice[], string, uint, nint[], out nint, nint, nint)

Introduced in OpenCL 1.2.

Declaration
public static extern CLResultCode CompileProgram(CLProgram program, uint numberOfDevices, CLDevice[] deviceList, string options, uint numberOfInputDevices, nint[] inputHeaders, out nint headerIncludeNames, nint notificationCallback, nint userData)
Parameters
Type Name Description
CLProgram program
uint numberOfDevices
CLDevice[] deviceList
string options
uint numberOfInputDevices
nint[] inputHeaders
nint headerIncludeNames
nint notificationCallback
nint userData
Returns
Type Description
CLResultCode

CreateBuffer(CLContext, MemoryFlags, nuint, nint, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
public static extern CLBuffer CreateBuffer(CLContext context, MemoryFlags flags, nuint size, nint hostPtr, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
MemoryFlags flags
nuint size
nint hostPtr
CLResultCode resultCode
Returns
Type Description
CLBuffer

CreateBuffer<T>(CLContext, MemoryFlags, Span<T>, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
public static CLBuffer CreateBuffer<T>(CLContext context, MemoryFlags flags, Span<T> span, out CLResultCode resultCode) where T : unmanaged
Parameters
Type Name Description
CLContext context
MemoryFlags flags
Span<T> span
CLResultCode resultCode
Returns
Type Description
CLBuffer
Type Parameters
Name Description
T

CreateBuffer<T>(CLContext, MemoryFlags, T[], out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
public static CLBuffer CreateBuffer<T>(CLContext context, MemoryFlags flags, T[] array, out CLResultCode resultCode) where T : unmanaged
Parameters
Type Name Description
CLContext context
MemoryFlags flags
T[] array
CLResultCode resultCode
Returns
Type Description
CLBuffer
Type Parameters
Name Description
T

CreateCommandQueue(CLContext, CLDevice, CommandQueueProperty, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
[Obsolete("Deprecated in OpenCL 1.2, use CreateCommandQueueWithProperties.")]
public static extern CLCommandQueue CreateCommandQueue(CLContext context, CLDevice device, CommandQueueProperty properties, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
CLDevice device
CommandQueueProperty properties
CLResultCode resultCode
Returns
Type Description
CLCommandQueue

CreateCommandQueueWithProperties(CLContext, nint, nint, out CLResultCode)

Introduced in OpenCL 2.0.

Declaration
public static extern CLCommandQueue CreateCommandQueueWithProperties(CLContext context, nint device, nint properties, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
nint device
nint properties
CLResultCode resultCode
Returns
Type Description
CLCommandQueue

CreateContext(nint, CLDevice[], nint, nint, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
public static CLContext CreateContext(nint properties, CLDevice[] devices, nint notificationCallback, nint userData, out CLResultCode resultCode)
Parameters
Type Name Description
nint properties
CLDevice[] devices
nint notificationCallback
nint userData
CLResultCode resultCode
Returns
Type Description
CLContext

CreateContext(nint, uint, CLDevice[], nint, nint, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
public static extern CLContext CreateContext(nint properties, uint numberOfDevices, CLDevice[] devices, nint notificationCallback, nint userData, out CLResultCode resultCode)
Parameters
Type Name Description
nint properties
uint numberOfDevices
CLDevice[] devices
nint notificationCallback
nint userData
CLResultCode resultCode
Returns
Type Description
CLContext

CreateContext(nint[], CLDevice[], nint, nint, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
public static CLContext CreateContext(nint[] properties, CLDevice[] devices, nint notificationCallback, nint userData, out CLResultCode resultCode)
Parameters
Type Name Description
nint[] properties
CLDevice[] devices
nint notificationCallback
nint userData
CLResultCode resultCode
Returns
Type Description
CLContext

CreateContext(nint[], uint, CLDevice[], nint, nint, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
public static extern CLContext CreateContext(nint[] properties, uint numberOfDevices, CLDevice[] devices, nint notificationCallback, nint userData, out CLResultCode resultCode)
Parameters
Type Name Description
nint[] properties
uint numberOfDevices
CLDevice[] devices
nint notificationCallback
nint userData
CLResultCode resultCode
Returns
Type Description
CLContext

CreateContextFromType(nint, DeviceType, nint, nint, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
public static extern CLContext CreateContextFromType(nint properties, DeviceType deviceType, nint notificationCallback, nint userData, out CLResultCode resultCode)
Parameters
Type Name Description
nint properties
DeviceType deviceType
nint notificationCallback
nint userData
CLResultCode resultCode
Returns
Type Description
CLContext

CreateContextFromType(nint[], DeviceType, nint, nint, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
public static extern CLContext CreateContextFromType(nint[] properties, DeviceType deviceType, nint notificationCallback, nint userData, out CLResultCode resultCode)
Parameters
Type Name Description
nint[] properties
DeviceType deviceType
nint notificationCallback
nint userData
CLResultCode resultCode
Returns
Type Description
CLContext

CreateImage(CLContext, MemoryFlags, ref ImageFormat, ref ImageDescription, nint, out CLResultCode)

Introduced in OpenCL 1.2.

Declaration
public static extern CLImage CreateImage(CLContext context, MemoryFlags flags, ref ImageFormat imageFormat, ref ImageDescription imageDesc, nint hostPointer, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
MemoryFlags flags
ImageFormat imageFormat
ImageDescription imageDesc
nint hostPointer
CLResultCode resultCode
Returns
Type Description
CLImage

CreateImage2D(CLContext, MemoryFlags, ref ImageFormat, nuint, nuint, nuint, nint, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
[Obsolete("Deprecated method, use CreateImage instead")]
public static extern CLImage CreateImage2D(CLContext context, MemoryFlags flags, ref ImageFormat imageFormat, nuint imageWidth, nuint imageHeight, nuint imageRowPitch, nint hostPointer, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
MemoryFlags flags
ImageFormat imageFormat
nuint imageWidth
nuint imageHeight
nuint imageRowPitch
nint hostPointer
CLResultCode resultCode
Returns
Type Description
CLImage

CreateImage3D(CLContext, MemoryFlags, ref ImageFormat, nuint, nuint, nuint, nuint, nuint, nint, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
[Obsolete("Deprecated method, use CreateImage instead")]
public static extern CLImage CreateImage3D(CLContext context, MemoryFlags flags, ref ImageFormat imageFormat, nuint imageWidth, nuint imageHeight, nuint imageDepth, nuint imageRowPitch, nuint imageSlicePitch, nint hostPointer, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
MemoryFlags flags
ImageFormat imageFormat
nuint imageWidth
nuint imageHeight
nuint imageDepth
nuint imageRowPitch
nuint imageSlicePitch
nint hostPointer
CLResultCode resultCode
Returns
Type Description
CLImage

CreateKernel(CLProgram, string, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
public static extern CLKernel CreateKernel(CLProgram program, string name, out CLResultCode resultCode)
Parameters
Type Name Description
CLProgram program
string name
CLResultCode resultCode
Returns
Type Description
CLKernel

CreateKernelsInProgram(CLProgram, out CLKernel[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode CreateKernelsInProgram(CLProgram program, out CLKernel[] kernels)
Parameters
Type Name Description
CLProgram program
CLKernel[] kernels
Returns
Type Description
CLResultCode

CreateKernelsInProgram(CLProgram, uint, CLKernel[], out uint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode CreateKernelsInProgram(CLProgram program, uint numberOfKernels, CLKernel[] kernels, out uint numberOfKernelsReturned)
Parameters
Type Name Description
CLProgram program
uint numberOfKernels
CLKernel[] kernels
uint numberOfKernelsReturned
Returns
Type Description
CLResultCode

CreatePipe(CLContext, MemoryFlags, uint, uint, nint[], out CLResultCode)

Introduced in OpenCL 2.0.

Declaration
public static extern CLPipe CreatePipe(CLContext context, MemoryFlags flags, uint pipePacketSize, uint pipeMaxPackets, nint[] properties, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
MemoryFlags flags
uint pipePacketSize
uint pipeMaxPackets
nint[] properties
CLResultCode resultCode
Returns
Type Description
CLPipe

CreateProgramWithBinary(CLContext, uint, nint[], nuint[], nint[], out CLResultCode[], out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
public static extern CLProgram CreateProgramWithBinary(CLContext context, uint numberOfDevices, nint[] deviceList, nuint[] lengths, nint[] binaries, out CLResultCode[] binaryStatus, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
uint numberOfDevices
nint[] deviceList
nuint[] lengths
nint[] binaries
CLResultCode[] binaryStatus
CLResultCode resultCode
Returns
Type Description
CLProgram

CreateProgramWithBuiltInKernels(CLContext, uint, nint[], string, out CLResultCode)

Introduced in OpenCL 1.2.

Declaration
public static extern CLProgram CreateProgramWithBuiltInKernels(CLContext context, uint numberOfDevices, nint[] deviceList, string kernelNames, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
uint numberOfDevices
nint[] deviceList
string kernelNames
CLResultCode resultCode
Returns
Type Description
CLProgram

CreateProgramWithIL(CLContext, nint, nuint, out CLResultCode)

Introduced in OpenCL 2.1.

Declaration
public static extern CLProgram CreateProgramWithIL(CLContext context, nint il, nuint length, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
nint il
nuint length
CLResultCode resultCode
Returns
Type Description
CLProgram

CreateProgramWithSource(CLContext, string, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
public static CLProgram CreateProgramWithSource(CLContext context, string source, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
string source
CLResultCode resultCode
Returns
Type Description
CLProgram

CreateProgramWithSource(CLContext, uint, nint[], uint[], out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
public static extern CLProgram CreateProgramWithSource(CLContext context, uint count, nint[] strings, uint[] lengths, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
uint count
nint[] strings
uint[] lengths
CLResultCode resultCode
Returns
Type Description
CLProgram

CreateSampler(CLContext, uint, AddressingMode, FilterMode, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
[Obsolete("Deprecated in OpenCL 1.2")]
public static extern CLSampler CreateSampler(CLContext context, uint normalizedCoordinates, AddressingMode addressingMode, FilterMode filterMode, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
uint normalizedCoordinates
AddressingMode addressingMode
FilterMode filterMode
CLResultCode resultCode
Returns
Type Description
CLSampler

CreateSamplerWithProperties(CLContext, nint, out CLResultCode)

Introduced in OpenCL 2.0.

Declaration
public static extern CLSampler CreateSamplerWithProperties(CLContext context, nint samplerProperties, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
nint samplerProperties
CLResultCode resultCode
Returns
Type Description
CLSampler

CreateSubBuffer(CLBuffer, MemoryFlags, BufferCreateType, nint, out CLResultCode)

Introduced in OpenCL 1.1.

Declaration
public static extern CLBuffer CreateSubBuffer(CLBuffer buffer, MemoryFlags flags, BufferCreateType bufferCreateType, nint bufferCreateInfo, out CLResultCode resultCode)
Parameters
Type Name Description
CLBuffer buffer
MemoryFlags flags
BufferCreateType bufferCreateType
nint bufferCreateInfo
CLResultCode resultCode
Returns
Type Description
CLBuffer

CreateSubDevices(CLDevice, nint[], uint, CLDevice[], out uint)

Introduced in OpenCL 1.2.

Declaration
public static extern CLResultCode CreateSubDevices(CLDevice inDevice, nint[] properties, uint numberOfDevices, CLDevice[] outDevices, out uint devicesReturned)
Parameters
Type Name Description
CLDevice inDevice
nint[] properties
uint numberOfDevices
CLDevice[] outDevices
uint devicesReturned
Returns
Type Description
CLResultCode

CreateUserEvent(CLContext, out CLResultCode)

Introduced in OpenCL 1.1.

Declaration
public static extern CLEvent CreateUserEvent(CLContext context, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
CLResultCode resultCode
Returns
Type Description
CLEvent

EnqueueBarrier(CLCommandQueue)

Introduced in OpenCL 1.0.

Declaration
[Obsolete("Deprecated in OpenCL 1.1, use EnqueueBarrierWithWaitList.")]
public static extern CLResultCode EnqueueBarrier(CLCommandQueue commandQueue)
Parameters
Type Name Description
CLCommandQueue commandQueue
Returns
Type Description
CLResultCode

EnqueueBarrierWithWaitList(CLCommandQueue, uint, nint[], nint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.2.

Declaration
public static extern CLResultCode EnqueueBarrierWithWaitList(CLCommandQueue commandQueue, uint numberOfMemoryObjects, nint[] memoryObjects, nint argumentsMemoryLocation, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
uint numberOfMemoryObjects
nint[] memoryObjects
nint argumentsMemoryLocation
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueCopyBuffer(CLCommandQueue, CLBuffer, CLBuffer, nuint, nuint, nuint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode EnqueueCopyBuffer(CLCommandQueue commandQueue, CLBuffer srcBuffer, CLBuffer dstBuffer, nuint srcOffset, nuint dstOffset, nuint size, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer srcBuffer
CLBuffer dstBuffer
nuint srcOffset
nuint dstOffset
nuint size
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueCopyBufferRect(CLCommandQueue, CLBuffer, CLBuffer, nuint[], nuint[], nuint[], nuint, nuint, nuint, nuint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.1.

Declaration
public static extern CLResultCode EnqueueCopyBufferRect(CLCommandQueue commandQueue, CLBuffer srcBuffer, CLBuffer dstBuffer, nuint[] srcOrigin, nuint[] dstOrigin, nuint[] region, nuint srcRowPitch, nuint srcSlicePitch, nuint dstRowPitch, nuint dstSlicePitch, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer srcBuffer
CLBuffer dstBuffer
nuint[] srcOrigin
nuint[] dstOrigin
nuint[] region
nuint srcRowPitch
nuint srcSlicePitch
nuint dstRowPitch
nuint dstSlicePitch
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueCopyBufferToImage(CLCommandQueue, CLBuffer, CLImage, nuint, nuint[], nuint[], uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode EnqueueCopyBufferToImage(CLCommandQueue commandQueue, CLBuffer srcBuffer, CLImage dstImage, nuint srcOffset, nuint[] dstOrigin, nuint[] region, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer srcBuffer
CLImage dstImage
nuint srcOffset
nuint[] dstOrigin
nuint[] region
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueCopyImage(CLCommandQueue, CLImage, CLImage, nuint[], nuint[], nuint[], uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode EnqueueCopyImage(CLCommandQueue commandQueue, CLImage srcImage, CLImage dstImage, nuint[] srcOrigin, nuint[] dstOrigin, nuint[] region, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLImage srcImage
CLImage dstImage
nuint[] srcOrigin
nuint[] dstOrigin
nuint[] region
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueCopyImageToBuffer(CLCommandQueue, CLImage, CLBuffer, nuint[], nuint[], nuint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode EnqueueCopyImageToBuffer(CLCommandQueue commandQueue, CLImage srcImage, CLBuffer dstBuffer, nuint[] srcOrigin, nuint[] region, nuint dstOffset, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLImage srcImage
CLBuffer dstBuffer
nuint[] srcOrigin
nuint[] region
nuint dstOffset
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueFillBuffer(CLCommandQueue, CLBuffer, nint, nuint, nuint, nuint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.2.

Declaration
public static extern CLResultCode EnqueueFillBuffer(CLCommandQueue commandQueue, CLBuffer buffer, nint pattern, nuint patternSize, nuint offset, nuint size, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer buffer
nint pattern
nuint patternSize
nuint offset
nuint size
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueFillBuffer<T>(CLCommandQueue, CLBuffer, T[], nuint, nuint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.2.

Declaration
public static CLResultCode EnqueueFillBuffer<T>(CLCommandQueue commandQueue, CLBuffer buffer, T[] pattern, nuint offset, nuint size, CLEvent[] eventWaitList, out CLEvent @event) where T : unmanaged
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer buffer
T[] pattern
nuint offset
nuint size
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode
Type Parameters
Name Description
T

EnqueueFillImage(CLCommandQueue, CLImage, nint, nuint[], nuint[], uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.2.

Declaration
public static extern CLResultCode EnqueueFillImage(CLCommandQueue commandQueue, CLImage image, nint fillColor, nuint[] origin, nuint[] region, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLImage image
nint fillColor
nuint[] origin
nuint[] region
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueMapBuffer(CLCommandQueue, CLBuffer, bool, MapFlags, nuint, nuint, uint, CLEvent[], out CLEvent, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
public static extern nint EnqueueMapBuffer(CLCommandQueue commandQueue, CLBuffer buffer, bool blockingMap, MapFlags flags, nuint offset, nuint size, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event, out CLResultCode resultCode)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer buffer
bool blockingMap
MapFlags flags
nuint offset
nuint size
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
CLResultCode resultCode
Returns
Type Description
nint

EnqueueMapImage(CLCommandQueue, CLImage, bool, MapFlags, nuint[], nuint[], nuint, nuint, uint, CLEvent[], out CLEvent, out CLResultCode)

Introduced in OpenCL 1.0.

Declaration
public static extern nint EnqueueMapImage(CLCommandQueue commandQueue, CLImage image, bool blockingMap, MapFlags flags, nuint[] origin, nuint[] region, nuint rowPitch, nuint slicePitch, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event, out CLResultCode resultCode)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLImage image
bool blockingMap
MapFlags flags
nuint[] origin
nuint[] region
nuint rowPitch
nuint slicePitch
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
CLResultCode resultCode
Returns
Type Description
nint

EnqueueMarker(CLCommandQueue, CLEvent)

Introduced in OpenCL 1.0.

Declaration
[Obsolete("Deprecated in OpenCL 1.1, use EnqueueMarkerWithWaitList.")]
public static extern CLResultCode EnqueueMarker(CLCommandQueue commandQueue, CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLEvent event
Returns
Type Description
CLResultCode

EnqueueMarkerWithWaitList(CLCommandQueue, uint, nint[], nint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.2.

Declaration
public static extern CLResultCode EnqueueMarkerWithWaitList(CLCommandQueue commandQueue, uint numberOfMemoryObjects, nint[] memoryObjects, nint argumentsMemoryLocation, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
uint numberOfMemoryObjects
nint[] memoryObjects
nint argumentsMemoryLocation
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueMigrateMemoryObjects(CLCommandQueue, uint, nint[], MemoryMigrationFlags, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.2.

Declaration
public static extern CLResultCode EnqueueMigrateMemoryObjects(CLCommandQueue commandQueue, uint numberOfMemoryObjects, nint[] memoryObjects, MemoryMigrationFlags flags, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
uint numberOfMemoryObjects
nint[] memoryObjects
MemoryMigrationFlags flags
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueNDRangeKernel(CLCommandQueue, CLKernel, uint, nuint[], nuint[], nuint[], uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode EnqueueNDRangeKernel(CLCommandQueue commandQueue, CLKernel kernel, uint workDimension, nuint[] globalWorkOffset, nuint[] globalWorkSize, nuint[] localWorkSize, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLKernel kernel
uint workDimension
nuint[] globalWorkOffset
nuint[] globalWorkSize
nuint[] localWorkSize
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueNativeKernel(CLCommandQueue, nint, nint[], nuint, uint, nint[], nint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode EnqueueNativeKernel(CLCommandQueue commandQueue, nint userFunction, nint[] arguments, nuint argumentSize, uint numberOfMemoryObjects, nint[] memoryObjects, nint argumentsMemoryLocation, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
nint userFunction
nint[] arguments
nuint argumentSize
uint numberOfMemoryObjects
nint[] memoryObjects
nint argumentsMemoryLocation
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueReadBuffer(CLCommandQueue, CLBuffer, bool, nuint, nuint, nint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode EnqueueReadBuffer(CLCommandQueue commandQueue, CLBuffer buffer, bool blockingRead, nuint offset, nuint size, nint pointer, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer buffer
bool blockingRead
nuint offset
nuint size
nint pointer
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueReadBufferRect(CLCommandQueue, CLBuffer, bool, nuint[], nuint[], nuint[], nuint, nuint, nuint, nuint, nint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.1.

Declaration
public static extern CLResultCode EnqueueReadBufferRect(CLCommandQueue commandQueue, CLBuffer buffer, bool blockingRead, nuint[] bufferOffset, nuint[] hostOffset, nuint[] region, nuint bufferRowPitch, nuint bufferSlicePitch, nuint hostRowPitch, nuint hostSlicePitch, nint pointer, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer buffer
bool blockingRead
nuint[] bufferOffset
nuint[] hostOffset
nuint[] region
nuint bufferRowPitch
nuint bufferSlicePitch
nuint hostRowPitch
nuint hostSlicePitch
nint pointer
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueReadBufferRect<T>(CLCommandQueue, CLBuffer, bool, nuint[], nuint[], nuint[], nuint, nuint, nuint, nuint, Span<T>, CLEvent[], out CLEvent)

Introduced in OpenCL 1.1.

Declaration
public static CLResultCode EnqueueReadBufferRect<T>(CLCommandQueue commandQueue, CLBuffer buffer, bool blockingRead, nuint[] bufferOffset, nuint[] hostOffset, nuint[] region, nuint bufferRowPitch, nuint bufferSlicePitch, nuint hostRowPitch, nuint hostSlicePitch, Span<T> span, CLEvent[] eventWaitList, out CLEvent @event) where T : unmanaged
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer buffer
bool blockingRead
nuint[] bufferOffset
nuint[] hostOffset
nuint[] region
nuint bufferRowPitch
nuint bufferSlicePitch
nuint hostRowPitch
nuint hostSlicePitch
Span<T> span
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode
Type Parameters
Name Description
T

EnqueueReadBufferRect<T>(CLCommandQueue, CLBuffer, bool, nuint[], nuint[], nuint[], nuint, nuint, nuint, nuint, T[], CLEvent[], out CLEvent)

Introduced in OpenCL 1.1.

Declaration
public static CLResultCode EnqueueReadBufferRect<T>(CLCommandQueue commandQueue, CLBuffer buffer, bool blockingRead, nuint[] bufferOffset, nuint[] hostOffset, nuint[] region, nuint bufferRowPitch, nuint bufferSlicePitch, nuint hostRowPitch, nuint hostSlicePitch, T[] array, CLEvent[] eventWaitList, out CLEvent @event) where T : unmanaged
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer buffer
bool blockingRead
nuint[] bufferOffset
nuint[] hostOffset
nuint[] region
nuint bufferRowPitch
nuint bufferSlicePitch
nuint hostRowPitch
nuint hostSlicePitch
T[] array
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode
Type Parameters
Name Description
T

EnqueueReadBuffer<T>(CLCommandQueue, CLBuffer, bool, nuint, Span<T>, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode EnqueueReadBuffer<T>(CLCommandQueue commandQueue, CLBuffer buffer, bool blockingRead, nuint offset, Span<T> span, CLEvent[] eventWaitList, out CLEvent eventHandle) where T : unmanaged
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer buffer
bool blockingRead
nuint offset
Span<T> span
CLEvent[] eventWaitList
CLEvent eventHandle
Returns
Type Description
CLResultCode
Type Parameters
Name Description
T

EnqueueReadBuffer<T>(CLCommandQueue, CLBuffer, bool, nuint, T[], CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode EnqueueReadBuffer<T>(CLCommandQueue commandQueue, CLBuffer buffer, bool blockingRead, nuint offset, T[] array, CLEvent[] eventWaitList, out CLEvent eventHandle) where T : unmanaged
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer buffer
bool blockingRead
nuint offset
T[] array
CLEvent[] eventWaitList
CLEvent eventHandle
Returns
Type Description
CLResultCode
Type Parameters
Name Description
T

EnqueueReadImage(CLCommandQueue, CLImage, bool, nuint[], nuint[], nuint, nuint, nint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode EnqueueReadImage(CLCommandQueue commandQueue, CLImage image, bool blockingRead, nuint[] origin, nuint[] region, nuint rowPitch, nuint slicePitch, nint pointer, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLImage image
bool blockingRead
nuint[] origin
nuint[] region
nuint rowPitch
nuint slicePitch
nint pointer
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueSVMFree(CLCommandQueue, uint, nint[], nint, nint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 2.0.

Declaration
public static extern CLResultCode EnqueueSVMFree(CLCommandQueue commandQueue, uint numberOfSvmPointers, nint[] svmPointers, nint svmFreePointersCallback, nint userData, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
uint numberOfSvmPointers
nint[] svmPointers
nint svmFreePointersCallback
nint userData
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueSVMUnmap(CLCommandQueue, nint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 2.0.

Declaration
public static extern CLResultCode EnqueueSVMUnmap(CLCommandQueue commandQueue, nint svmPointer, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
nint svmPointer
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueSvmMap(CLCommandQueue, bool, MapFlags, nint, nuint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 2.0.

Declaration
public static extern CLResultCode EnqueueSvmMap(CLCommandQueue commandQueue, bool blockingMap, MapFlags mapFlag, nint svmPointer, nuint size, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
bool blockingMap
MapFlags mapFlag
nint svmPointer
nuint size
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueSvmMemoryCopy(CLCommandQueue, bool, nint, nint, nuint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 2.0.

Declaration
public static extern CLResultCode EnqueueSvmMemoryCopy(CLCommandQueue commandQueue, bool blockingCopy, nint dstPointer, nint srcPointer, nuint size, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
bool blockingCopy
nint dstPointer
nint srcPointer
nuint size
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueSvmMemoryFill(CLCommandQueue, nint, nint, nuint, nuint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 2.0.

Declaration
public static extern CLResultCode EnqueueSvmMemoryFill(CLCommandQueue commandQueue, nint svmPointer, nint pattern, nuint patternSize, nuint size, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
nint svmPointer
nint pattern
nuint patternSize
nuint size
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueSvmMigrateMemory(CLCommandQueue, uint, nint[], nuint[], MemoryMigrationFlags, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 2.1.

Declaration
public static extern CLResultCode EnqueueSvmMigrateMemory(CLCommandQueue commandQueue, uint numberOfSvmPointers, nint[] svmPointers, nuint[] sizes, MemoryMigrationFlags memoryMigrationFlags, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
uint numberOfSvmPointers
nint[] svmPointers
nuint[] sizes
MemoryMigrationFlags memoryMigrationFlags
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueTask(CLCommandQueue, CLKernel, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
[Obsolete("Deprecated in OpenCL 1.2")]
public static extern CLResultCode EnqueueTask(CLCommandQueue commandQueue, CLKernel kernel, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLKernel kernel
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueUnmapMemoryObject(CLCommandQueue, CLBuffer, nint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode EnqueueUnmapMemoryObject(CLCommandQueue commandQueue, CLBuffer memoryObject, nint mapperPtr, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer memoryObject
nint mapperPtr
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueUnmapMemoryObject(CLCommandQueue, CLImage, nint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode EnqueueUnmapMemoryObject(CLCommandQueue commandQueue, CLImage memoryObject, nint mapperPtr, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLImage memoryObject
nint mapperPtr
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueUnmapMemoryObject(CLCommandQueue, nint, nint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode EnqueueUnmapMemoryObject(CLCommandQueue commandQueue, nint memoryObject, nint mapperPtr, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
nint memoryObject
nint mapperPtr
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueWaitForEvents(CLCommandQueue, uint, CLEvent[])

Introduced in OpenCL 1.0.

Declaration
[Obsolete("Deprecated in OpenCL 1.1, use EnqueueMarkerWithWaitList.")]
public static extern CLResultCode EnqueueWaitForEvents(CLCommandQueue commandQueue, uint numberOfEventsInWaitList, CLEvent[] eventList)
Parameters
Type Name Description
CLCommandQueue commandQueue
uint numberOfEventsInWaitList
CLEvent[] eventList
Returns
Type Description
CLResultCode

EnqueueWriteBuffer(CLCommandQueue, CLBuffer, bool, nuint, nuint, nint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode EnqueueWriteBuffer(CLCommandQueue commandQueue, CLBuffer buffer, bool blockingWrite, nuint offset, nuint size, nint pointer, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer buffer
bool blockingWrite
nuint offset
nuint size
nint pointer
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueWriteBufferRect(CLCommandQueue, CLBuffer, bool, nuint[], nuint[], nuint[], nuint, nuint, nuint, nuint, nint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.1.

Declaration
public static extern CLResultCode EnqueueWriteBufferRect(CLCommandQueue commandQueue, CLBuffer buffer, bool blockingWrite, nuint[] bufferOffset, nuint[] hostOffset, nuint[] region, nuint bufferRowPitch, nuint bufferSlicePitch, nuint hostRowPitch, nuint hostSlicePitch, nint pointer, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer buffer
bool blockingWrite
nuint[] bufferOffset
nuint[] hostOffset
nuint[] region
nuint bufferRowPitch
nuint bufferSlicePitch
nuint hostRowPitch
nuint hostSlicePitch
nint pointer
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

EnqueueWriteBufferRect<T>(CLCommandQueue, CLBuffer, bool, nuint[], nuint[], nuint[], nuint, nuint, nuint, nuint, Span<T>, CLEvent[], out CLEvent)

Introduced in OpenCL 1.1.

Declaration
public static CLResultCode EnqueueWriteBufferRect<T>(CLCommandQueue commandQueue, CLBuffer buffer, bool blockingWrite, nuint[] bufferOffset, nuint[] hostOffset, nuint[] region, nuint bufferRowPitch, nuint bufferSlicePitch, nuint hostRowPitch, nuint hostSlicePitch, Span<T> span, CLEvent[] eventWaitList, out CLEvent @event) where T : unmanaged
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer buffer
bool blockingWrite
nuint[] bufferOffset
nuint[] hostOffset
nuint[] region
nuint bufferRowPitch
nuint bufferSlicePitch
nuint hostRowPitch
nuint hostSlicePitch
Span<T> span
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode
Type Parameters
Name Description
T

EnqueueWriteBufferRect<T>(CLCommandQueue, CLBuffer, bool, nuint[], nuint[], nuint[], nuint, nuint, nuint, nuint, T[], CLEvent[], out CLEvent)

Introduced in OpenCL 1.1.

Declaration
public static CLResultCode EnqueueWriteBufferRect<T>(CLCommandQueue commandQueue, CLBuffer buffer, bool blockingWrite, nuint[] bufferOffset, nuint[] hostOffset, nuint[] region, nuint bufferRowPitch, nuint bufferSlicePitch, nuint hostRowPitch, nuint hostSlicePitch, T[] array, CLEvent[] eventWaitList, out CLEvent @event) where T : unmanaged
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer buffer
bool blockingWrite
nuint[] bufferOffset
nuint[] hostOffset
nuint[] region
nuint bufferRowPitch
nuint bufferSlicePitch
nuint hostRowPitch
nuint hostSlicePitch
T[] array
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode
Type Parameters
Name Description
T

EnqueueWriteBuffer<T>(CLCommandQueue, CLBuffer, bool, nuint, Span<T>, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode EnqueueWriteBuffer<T>(CLCommandQueue commandQueue, CLBuffer buffer, bool blockingWrite, nuint offset, Span<T> span, CLEvent[] eventWaitList, out CLEvent @event) where T : unmanaged
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer buffer
bool blockingWrite
nuint offset
Span<T> span
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode
Type Parameters
Name Description
T

EnqueueWriteBuffer<T>(CLCommandQueue, CLBuffer, bool, nuint, T[], CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode EnqueueWriteBuffer<T>(CLCommandQueue commandQueue, CLBuffer buffer, bool blockingWrite, nuint offset, T[] array, CLEvent[] eventWaitList, out CLEvent @event) where T : unmanaged
Parameters
Type Name Description
CLCommandQueue commandQueue
CLBuffer buffer
bool blockingWrite
nuint offset
T[] array
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode
Type Parameters
Name Description
T

EnqueueWriteImage(CLCommandQueue, CLImage, bool, nuint[], nuint[], nuint, nuint, nint, uint, CLEvent[], out CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode EnqueueWriteImage(CLCommandQueue commandQueue, CLImage image, bool blockingWrite, nuint[] origin, nuint[] region, nuint inputRowPitch, nuint inputSlicePitch, nint pointer, uint numberOfEventsInWaitList, CLEvent[] eventWaitList, out CLEvent @event)
Parameters
Type Name Description
CLCommandQueue commandQueue
CLImage image
bool blockingWrite
nuint[] origin
nuint[] region
nuint inputRowPitch
nuint inputSlicePitch
nint pointer
uint numberOfEventsInWaitList
CLEvent[] eventWaitList
CLEvent event
Returns
Type Description
CLResultCode

Finish(CLCommandQueue)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode Finish(CLCommandQueue commandQueue)
Parameters
Type Name Description
CLCommandQueue commandQueue
Returns
Type Description
CLResultCode

Flush(CLCommandQueue)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode Flush(CLCommandQueue commandQueue)
Parameters
Type Name Description
CLCommandQueue commandQueue
Returns
Type Description
CLResultCode

GetCommandQueueInfo(CLCommandQueue, CommandQueueInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetCommandQueueInfo(CLCommandQueue queue, CommandQueueInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLCommandQueue queue
CommandQueueInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetCommandQueueInfo(CLCommandQueue, CommandQueueInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetCommandQueueInfo(CLCommandQueue commandQueue, CommandQueueInfo paramName, nuint paramSize, byte[] paramValue, out nuint paramValueSizeReturned)
Parameters
Type Name Description
CLCommandQueue commandQueue
CommandQueueInfo paramName
nuint paramSize
byte[] paramValue
nuint paramValueSizeReturned
Returns
Type Description
CLResultCode

GetContextInfo(CLContext, ContextInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetContextInfo(CLContext context, ContextInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLContext context
ContextInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetContextInfo(CLContext, ContextInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetContextInfo(CLContext context, ContextInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramValueSizeReturned)
Parameters
Type Name Description
CLContext context
ContextInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramValueSizeReturned
Returns
Type Description
CLResultCode

GetDeviceAndHostTimer(CLDevice, nint, nint)

Introduced in OpenCL 2.1.

Declaration
public static extern CLResultCode GetDeviceAndHostTimer(CLDevice device, nint deviceTimestamp, nint hostTimestamp)
Parameters
Type Name Description
CLDevice device
nint deviceTimestamp
nint hostTimestamp
Returns
Type Description
CLResultCode

GetDeviceIds(CLPlatform, DeviceType, out CLDevice[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetDeviceIds(CLPlatform platform, DeviceType deviceType, out CLDevice[] deviceIds)
Parameters
Type Name Description
CLPlatform platform
DeviceType deviceType
CLDevice[] deviceIds
Returns
Type Description
CLResultCode

GetDeviceIds(CLPlatform, DeviceType, uint, CLDevice[], out uint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetDeviceIds(CLPlatform platform, DeviceType deviceType, uint numberOfEntries, CLDevice[] devices, out uint numberOfDevicesReturned)
Parameters
Type Name Description
CLPlatform platform
DeviceType deviceType
uint numberOfEntries
CLDevice[] devices
uint numberOfDevicesReturned
Returns
Type Description
CLResultCode

GetDeviceInfo(CLDevice, DeviceInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetDeviceInfo(CLDevice device, DeviceInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLDevice device
DeviceInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetDeviceInfo(CLDevice, DeviceInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetDeviceInfo(CLDevice device, DeviceInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramValueSizeReturned)
Parameters
Type Name Description
CLDevice device
DeviceInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramValueSizeReturned
Returns
Type Description
CLResultCode

GetEventInfo(CLEvent, EventInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetEventInfo(CLEvent @event, EventInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLEvent event
EventInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetEventInfo(CLEvent, EventInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetEventInfo(CLEvent @event, EventInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramSizeReturned)
Parameters
Type Name Description
CLEvent event
EventInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramSizeReturned
Returns
Type Description
CLResultCode

GetEventProfilingInfo(CLEvent, ProfilingInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetEventProfilingInfo(CLEvent @event, ProfilingInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLEvent event
ProfilingInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetEventProfilingInfo(CLEvent, ProfilingInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetEventProfilingInfo(CLEvent @event, ProfilingInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramValueSizeReturned)
Parameters
Type Name Description
CLEvent event
ProfilingInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramValueSizeReturned
Returns
Type Description
CLResultCode

GetExtensionFunctionAddress(string)

Introduced in OpenCL 1.0.

Declaration
[Obsolete("Deprecated method")]
public static extern CLResultCode GetExtensionFunctionAddress(string funcName)
Parameters
Type Name Description
string funcName
Returns
Type Description
CLResultCode

GetExtensionFunctionAddressForPlatform(CLPlatform, string)

Introduced in OpenCL 1.2.

Declaration
public static extern nint GetExtensionFunctionAddressForPlatform(CLPlatform platform, string functionName)
Parameters
Type Name Description
CLPlatform platform
string functionName
Returns
Type Description
nint

GetHostTimer(CLDevice, nint)

Introduced in OpenCL 2.1.

Declaration
public static extern CLResultCode GetHostTimer(CLDevice device, nint hostTimestamp)
Parameters
Type Name Description
CLDevice device
nint hostTimestamp
Returns
Type Description
CLResultCode

GetImageInfo(CLImage, ImageInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetImageInfo(CLImage image, ImageInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLImage image
ImageInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetImageInfo(CLImage, ImageInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetImageInfo(CLImage image, ImageInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramValueSizeReturned)
Parameters
Type Name Description
CLImage image
ImageInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramValueSizeReturned
Returns
Type Description
CLResultCode

GetKernelArgInfo(CLKernel, uint, KernelArgInfo, out byte[])

Introduced in OpenCL 1.2.

Declaration
public static CLResultCode GetKernelArgInfo(CLKernel kernel, uint argumentIndex, KernelArgInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLKernel kernel
uint argumentIndex
KernelArgInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetKernelArgInfo(CLKernel, uint, KernelArgInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.2.

Declaration
public static extern CLResultCode GetKernelArgInfo(CLKernel kernel, uint argumentIndex, KernelArgInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramSizeReturned)
Parameters
Type Name Description
CLKernel kernel
uint argumentIndex
KernelArgInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramSizeReturned
Returns
Type Description
CLResultCode

GetKernelInfo(CLKernel, KernelInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetKernelInfo(CLKernel kernel, KernelInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLKernel kernel
KernelInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetKernelInfo(CLKernel, KernelInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetKernelInfo(CLKernel kernel, KernelInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramSizeReturned)
Parameters
Type Name Description
CLKernel kernel
KernelInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramSizeReturned
Returns
Type Description
CLResultCode

GetKernelSubGroupInfo(CLKernel, CLDevice, KernelSubGroupInfo, nuint, nint, nuint, byte[], out nuint)

Introduced in OpenCL 2.1.

Declaration
public static extern CLResultCode GetKernelSubGroupInfo(CLKernel kernel, CLDevice device, KernelSubGroupInfo paramName, nuint inputValueSize, nint inputValue, nuint paramValueSize, byte[] paramValue, out nuint paramSizeReturned)
Parameters
Type Name Description
CLKernel kernel
CLDevice device
KernelSubGroupInfo paramName
nuint inputValueSize
nint inputValue
nuint paramValueSize
byte[] paramValue
nuint paramSizeReturned
Returns
Type Description
CLResultCode

GetKernelWorkGroupInfo(CLKernel, CLDevice, KernelWorkGroupInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetKernelWorkGroupInfo(CLKernel kernel, CLDevice device, KernelWorkGroupInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLKernel kernel
CLDevice device
KernelWorkGroupInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetKernelWorkGroupInfo(CLKernel, CLDevice, KernelWorkGroupInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetKernelWorkGroupInfo(CLKernel kernel, CLDevice device, KernelWorkGroupInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramSizeReturned)
Parameters
Type Name Description
CLKernel kernel
CLDevice device
KernelWorkGroupInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramSizeReturned
Returns
Type Description
CLResultCode

GetMemObjectInfo(CLBuffer, MemoryObjectInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetMemObjectInfo(CLBuffer memoryObject, MemoryObjectInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLBuffer memoryObject
MemoryObjectInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetMemObjectInfo(CLBuffer, MemoryObjectInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetMemObjectInfo(CLBuffer memoryObject, MemoryObjectInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramValueSizeReturned)
Parameters
Type Name Description
CLBuffer memoryObject
MemoryObjectInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramValueSizeReturned
Returns
Type Description
CLResultCode

GetMemObjectInfo(CLImage, MemoryObjectInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetMemObjectInfo(CLImage memoryObject, MemoryObjectInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLImage memoryObject
MemoryObjectInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetMemObjectInfo(CLImage, MemoryObjectInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetMemObjectInfo(CLImage memoryObject, MemoryObjectInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramValueSizeReturned)
Parameters
Type Name Description
CLImage memoryObject
MemoryObjectInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramValueSizeReturned
Returns
Type Description
CLResultCode

GetMemObjectInfo(CLPipe, MemoryObjectInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetMemObjectInfo(CLPipe memoryObject, MemoryObjectInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLPipe memoryObject
MemoryObjectInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetMemObjectInfo(CLPipe, MemoryObjectInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetMemObjectInfo(CLPipe memoryObject, MemoryObjectInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramValueSizeReturned)
Parameters
Type Name Description
CLPipe memoryObject
MemoryObjectInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramValueSizeReturned
Returns
Type Description
CLResultCode

GetMemObjectInfo(nint, MemoryObjectInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetMemObjectInfo(nint memoryObject, MemoryObjectInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
nint memoryObject
MemoryObjectInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetMemObjectInfo(nint, MemoryObjectInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetMemObjectInfo(nint memoryObject, MemoryObjectInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramValueSizeReturned)
Parameters
Type Name Description
nint memoryObject
MemoryObjectInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramValueSizeReturned
Returns
Type Description
CLResultCode

GetPipeInfo(CLPipe, PipeInfo, out byte[])

Introduced in OpenCL 2.0.

Declaration
public static CLResultCode GetPipeInfo(CLPipe pipe, PipeInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLPipe pipe
PipeInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetPipeInfo(CLPipe, PipeInfo, nuint, byte[], out nuint)

Introduced in OpenCL 2.0.

Declaration
public static extern CLResultCode GetPipeInfo(CLPipe pipe, PipeInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramValueSizeReturned)
Parameters
Type Name Description
CLPipe pipe
PipeInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramValueSizeReturned
Returns
Type Description
CLResultCode

GetPlatformIds(out CLPlatform[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetPlatformIds(out CLPlatform[] platformIds)
Parameters
Type Name Description
CLPlatform[] platformIds

returns a list of OpenCL platforms found. The CLPlatform values returned in platforms can be used to identify a specific OpenCL platform.

Returns
Type Description
CLResultCode

returns Success if the function is executed successfully. Otherwise, it returns one of the following errors: -InvalidValue if numberOfEntries is equal to zero and platforms is not NULL or if both numberOfPlatforms and platforms are NULL. -OutOfHostMemory if there is a failure to allocate resources required by the OpenCL implementation on the host.

GetPlatformIds(uint, CLPlatform[], out uint)

Introduced in OpenCL 1.0. See more: https://www.khronos.org/registry/OpenCL/sdk/2.2/docs/man/html/clGetPlatformIDs.html.

Declaration
public static extern CLResultCode GetPlatformIds(uint numberOfEntries, CLPlatform[] platforms, out uint numberOfPlatforms)
Parameters
Type Name Description
uint numberOfEntries

number of CLPlatform entries that can be added to platforms. If platforms is not NULL, numberOfEntries must be greater than zero.

CLPlatform[] platforms

returns a list of OpenCL platforms found. The CLPlatform values returned in platforms can be used to identify a specific OpenCL platform. If platforms is NULL, this argument is ignored. The number of OpenCL platforms returned is the minimum of the value specified by numberOfEntries or the number of OpenCL platforms available.

uint numberOfPlatforms

returns the number of OpenCL platforms available. If numberOfPlatforms is NULL, this argument is ignored.

Returns
Type Description
CLResultCode

returns Success if the function is executed successfully. Otherwise, it returns one of the following errors: -InvalidValue if numberOfEntries is equal to zero and platforms is not NULL or if both numberOfPlatforms and platforms are NULL. -OutOfHostMemory if there is a failure to allocate resources required by the OpenCL implementation on the host.

GetPlatformInfo(CLPlatform, PlatformInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetPlatformInfo(CLPlatform platform, PlatformInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLPlatform platform
PlatformInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetPlatformInfo(CLPlatform, PlatformInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetPlatformInfo(CLPlatform platform, PlatformInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramValueSizeReturned)
Parameters
Type Name Description
CLPlatform platform
PlatformInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramValueSizeReturned
Returns
Type Description
CLResultCode

GetProgramBuildInfo(CLProgram, CLDevice, ProgramBuildInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetProgramBuildInfo(CLProgram program, CLDevice device, ProgramBuildInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLProgram program
CLDevice device
ProgramBuildInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetProgramBuildInfo(CLProgram, CLDevice, ProgramBuildInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetProgramBuildInfo(CLProgram program, CLDevice device, ProgramBuildInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramValueSizeReturned)
Parameters
Type Name Description
CLProgram program
CLDevice device
ProgramBuildInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramValueSizeReturned
Returns
Type Description
CLResultCode

GetProgramInfo(CLProgram, ProgramInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetProgramInfo(CLProgram program, ProgramInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLProgram program
ProgramInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetProgramInfo(CLProgram, ProgramInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetProgramInfo(CLProgram program, ProgramInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramValueSizeReturned)
Parameters
Type Name Description
CLProgram program
ProgramInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramValueSizeReturned
Returns
Type Description
CLResultCode

GetSamplerInfo(CLSampler, SamplerInfo, out byte[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetSamplerInfo(CLSampler sampler, SamplerInfo paramName, out byte[] paramValue)
Parameters
Type Name Description
CLSampler sampler
SamplerInfo paramName
byte[] paramValue
Returns
Type Description
CLResultCode

GetSamplerInfo(CLSampler, SamplerInfo, nuint, byte[], out nuint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetSamplerInfo(CLSampler sampler, SamplerInfo paramName, nuint paramValueSize, byte[] paramValue, out nuint paramValueSizeReturned)
Parameters
Type Name Description
CLSampler sampler
SamplerInfo paramName
nuint paramValueSize
byte[] paramValue
nuint paramValueSizeReturned
Returns
Type Description
CLResultCode

GetSupportedImageFormats(CLContext, MemoryFlags, MemoryObjectType, out ImageFormat[])

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode GetSupportedImageFormats(CLContext context, MemoryFlags flags, MemoryObjectType imageType, out ImageFormat[] imageFormats)
Parameters
Type Name Description
CLContext context
MemoryFlags flags
MemoryObjectType imageType
ImageFormat[] imageFormats
Returns
Type Description
CLResultCode

GetSupportedImageFormats(CLContext, MemoryFlags, MemoryObjectType, uint, ImageFormat[], out uint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode GetSupportedImageFormats(CLContext context, MemoryFlags flags, MemoryObjectType imageType, uint numberOfEntries, ImageFormat[] imageFormats, out uint numberOfImageFormats)
Parameters
Type Name Description
CLContext context
MemoryFlags flags
MemoryObjectType imageType
uint numberOfEntries
ImageFormat[] imageFormats
uint numberOfImageFormats
Returns
Type Description
CLResultCode

LinkProgram(CLContext, uint, CLDevice[], string, uint, CLProgram[], nint, nint, out CLResultCode)

Introduced in OpenCL 1.2.

Declaration
public static extern CLProgram LinkProgram(CLContext context, uint numberOfDevices, CLDevice[] deviceList, string options, uint numberOfPrograms, CLProgram[] inputPrograms, nint notificationCallback, nint userData, out CLResultCode resultCode)
Parameters
Type Name Description
CLContext context
uint numberOfDevices
CLDevice[] deviceList
string options
uint numberOfPrograms
CLProgram[] inputPrograms
nint notificationCallback
nint userData
CLResultCode resultCode
Returns
Type Description
CLProgram

ReleaseCommandQueue(CLCommandQueue)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode ReleaseCommandQueue(CLCommandQueue commandQueue)
Parameters
Type Name Description
CLCommandQueue commandQueue
Returns
Type Description
CLResultCode

ReleaseContext(CLContext)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode ReleaseContext(CLContext context)
Parameters
Type Name Description
CLContext context
Returns
Type Description
CLResultCode

ReleaseDevice(CLDevice)

Introduced in OpenCL 1.2.

Declaration
public static extern CLResultCode ReleaseDevice(CLDevice device)
Parameters
Type Name Description
CLDevice device
Returns
Type Description
CLResultCode

ReleaseEvent(CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode ReleaseEvent(CLEvent @event)
Parameters
Type Name Description
CLEvent event
Returns
Type Description
CLResultCode

ReleaseKernel(CLKernel)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode ReleaseKernel(CLKernel kernel)
Parameters
Type Name Description
CLKernel kernel
Returns
Type Description
CLResultCode

ReleaseMemoryObject(CLBuffer)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode ReleaseMemoryObject(CLBuffer memoryObject)
Parameters
Type Name Description
CLBuffer memoryObject
Returns
Type Description
CLResultCode

ReleaseMemoryObject(CLImage)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode ReleaseMemoryObject(CLImage memoryObject)
Parameters
Type Name Description
CLImage memoryObject
Returns
Type Description
CLResultCode

ReleaseMemoryObject(CLPipe)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode ReleaseMemoryObject(CLPipe memoryObject)
Parameters
Type Name Description
CLPipe memoryObject
Returns
Type Description
CLResultCode

ReleaseMemoryObject(nint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode ReleaseMemoryObject(nint memoryObject)
Parameters
Type Name Description
nint memoryObject
Returns
Type Description
CLResultCode

ReleaseProgram(CLProgram)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode ReleaseProgram(CLProgram program)
Parameters
Type Name Description
CLProgram program
Returns
Type Description
CLResultCode

ReleaseSampler(CLSampler)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode ReleaseSampler(CLSampler sampler)
Parameters
Type Name Description
CLSampler sampler
Returns
Type Description
CLResultCode

RetainCommandQueue(CLCommandQueue)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode RetainCommandQueue(CLCommandQueue commandQueue)
Parameters
Type Name Description
CLCommandQueue commandQueue
Returns
Type Description
CLResultCode

RetainContext(CLContext)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode RetainContext(CLContext context)
Parameters
Type Name Description
CLContext context
Returns
Type Description
CLResultCode

RetainDevice(CLDevice)

Introduced in OpenCL 1.2.

Declaration
public static extern CLResultCode RetainDevice(CLDevice device)
Parameters
Type Name Description
CLDevice device
Returns
Type Description
CLResultCode

RetainEvent(CLEvent)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode RetainEvent(CLEvent @event)
Parameters
Type Name Description
CLEvent event
Returns
Type Description
CLResultCode

RetainKernel(CLKernel)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode RetainKernel(CLKernel kernel)
Parameters
Type Name Description
CLKernel kernel
Returns
Type Description
CLResultCode

RetainMemoryObject(CLBuffer)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode RetainMemoryObject(CLBuffer memoryObject)
Parameters
Type Name Description
CLBuffer memoryObject
Returns
Type Description
CLResultCode

RetainMemoryObject(CLImage)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode RetainMemoryObject(CLImage memoryObject)
Parameters
Type Name Description
CLImage memoryObject
Returns
Type Description
CLResultCode

RetainMemoryObject(CLPipe)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode RetainMemoryObject(CLPipe memoryObject)
Parameters
Type Name Description
CLPipe memoryObject
Returns
Type Description
CLResultCode

RetainMemoryObject(nint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode RetainMemoryObject(nint memoryObject)
Parameters
Type Name Description
nint memoryObject
Returns
Type Description
CLResultCode

RetainProgram(CLProgram)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode RetainProgram(CLProgram program)
Parameters
Type Name Description
CLProgram program
Returns
Type Description
CLResultCode

RetainSampler(CLSampler)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode RetainSampler(CLSampler sampler)
Parameters
Type Name Description
CLSampler sampler
Returns
Type Description
CLResultCode

SVMAlloc(CLContext, SvmMemoryFlags, nuint, uint)

Introduced in OpenCL 2.0.

Declaration
public static extern nint SVMAlloc(CLContext context, SvmMemoryFlags flags, nuint size, uint alignment)
Parameters
Type Name Description
CLContext context
SvmMemoryFlags flags
nuint size
uint alignment
Returns
Type Description
nint

SVMFree(CLContext, nint)

Introduced in OpenCL 2.0.

Declaration
public static extern nint SVMFree(CLContext context, nint svmPointer)
Parameters
Type Name Description
CLContext context
nint svmPointer
Returns
Type Description
nint

SetDefaultDeviceCommandQueue(CLContext, CLDevice, CLCommandQueue)

Introduced in OpenCL 2.1.

Declaration
public static extern CLResultCode SetDefaultDeviceCommandQueue(CLContext context, CLDevice device, CLCommandQueue commandQueue)
Parameters
Type Name Description
CLContext context
CLDevice device
CLCommandQueue commandQueue
Returns
Type Description
CLResultCode

SetEventCallback(CLEvent, int, ClEventCallback)

Introduced in OpenCL 1.1.

Declaration
public static CLResultCode SetEventCallback(CLEvent eventHandle, int callbackType, CL.ClEventCallback notifyCallback)
Parameters
Type Name Description
CLEvent eventHandle
int callbackType
CL.ClEventCallback notifyCallback
Returns
Type Description
CLResultCode

SetEventCallback(CLEvent, int, nint, nint)

Introduced in OpenCL 1.1.

Declaration
public static extern CLResultCode SetEventCallback(CLEvent eventHandle, int commandExecCallbackType, nint notifyCallback, nint userData)
Parameters
Type Name Description
CLEvent eventHandle
int commandExecCallbackType
nint notifyCallback
nint userData
Returns
Type Description
CLResultCode

SetKernelArg(CLKernel, uint, nuint, nint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode SetKernelArg(CLKernel kernel, uint argumentIndex, nuint argumentSize, nint argumentValuePointer)
Parameters
Type Name Description
CLKernel kernel
uint argumentIndex
nuint argumentSize
nint argumentValuePointer
Returns
Type Description
CLResultCode

SetKernelArgSVMPointer(CLKernel, uint, nint)

Introduced in OpenCL 2.0.

Declaration
public static extern CLResultCode SetKernelArgSVMPointer(CLKernel kernel, uint argumentIndex, nint argumentValuePointer)
Parameters
Type Name Description
CLKernel kernel
uint argumentIndex
nint argumentValuePointer
Returns
Type Description
CLResultCode

SetKernelArg<T>(CLKernel, uint, in T)

Introduced in OpenCL 1.0.

Declaration
public static CLResultCode SetKernelArg<T>(CLKernel kernel, uint argumentIndex, in T argument) where T : unmanaged
Parameters
Type Name Description
CLKernel kernel
uint argumentIndex
T argument
Returns
Type Description
CLResultCode
Type Parameters
Name Description
T

SetKernelExecInfo(CLKernel, KernelExecInfo, nuint, nint)

Introduced in OpenCL 2.0.

Declaration
public static extern CLResultCode SetKernelExecInfo(CLKernel kernel, KernelExecInfo paramName, nuint paramValueSize, nint paramValue)
Parameters
Type Name Description
CLKernel kernel
KernelExecInfo paramName
nuint paramValueSize
nint paramValue
Returns
Type Description
CLResultCode

SetMemoryObjectDestructorCallback(CLBuffer, nint, nint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode SetMemoryObjectDestructorCallback(CLBuffer memoryObject, nint notificationCallback, nint userData)
Parameters
Type Name Description
CLBuffer memoryObject
nint notificationCallback
nint userData
Returns
Type Description
CLResultCode

SetMemoryObjectDestructorCallback(CLImage, nint, nint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode SetMemoryObjectDestructorCallback(CLImage memoryObject, nint notificationCallback, nint userData)
Parameters
Type Name Description
CLImage memoryObject
nint notificationCallback
nint userData
Returns
Type Description
CLResultCode

SetMemoryObjectDestructorCallback(CLPipe, nint, nint)

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode SetMemoryObjectDestructorCallback(CLPipe memoryObject, nint notificationCallback, nint userData)
Parameters
Type Name Description
CLPipe memoryObject
nint notificationCallback
nint userData
Returns
Type Description
CLResultCode

SetMemoryObjectDestructorCallback(nint, nint, nint)

Introduced in OpenCL 1.1.

Declaration
public static extern CLResultCode SetMemoryObjectDestructorCallback(nint memoryObject, nint notificationCallback, nint userData)
Parameters
Type Name Description
nint memoryObject
nint notificationCallback
nint userData
Returns
Type Description
CLResultCode

SetProgramReleaseCallback(CLProgram, nint, nint)

Introduced in OpenCL 2.2.

Declaration
public static extern CLResultCode SetProgramReleaseCallback(CLProgram program, nint notificationCallback, nint userData)
Parameters
Type Name Description
CLProgram program
nint notificationCallback
nint userData
Returns
Type Description
CLResultCode

SetProgramSpecializationConstant(CLProgram, uint, nuint, nint)

Introduced in OpenCL 2.2.

Declaration
public static extern CLResultCode SetProgramSpecializationConstant(CLProgram program, uint specId, nuint specSize, nint specValue)
Parameters
Type Name Description
CLProgram program
uint specId
nuint specSize
nint specValue
Returns
Type Description
CLResultCode

SetUserEventStatus(CLEvent, int)

Introduced in OpenCL 1.1.

Declaration
public static extern CLResultCode SetUserEventStatus(CLEvent @event, int executionStatus)
Parameters
Type Name Description
CLEvent event
int executionStatus
Returns
Type Description
CLResultCode

UnloadCompiler()

Introduced in OpenCL 1.0.

Declaration
[Obsolete("Deprecated in OpenCL 1.1, use UnloadPlatformCompiler.")]
public static extern CLResultCode UnloadCompiler()
Returns
Type Description
CLResultCode

UnloadPlatformCompiler(CLPlatform)

Introduced in OpenCL 1.2.

Declaration
public static extern CLResultCode UnloadPlatformCompiler(CLPlatform platform)
Parameters
Type Name Description
CLPlatform platform
Returns
Type Description
CLResultCode

WaitForEvents(uint, CLEvent[])

Introduced in OpenCL 1.0.

Declaration
public static extern CLResultCode WaitForEvents(uint numberOfEvents, CLEvent[] eventList)
Parameters
Type Name Description
uint numberOfEvents
CLEvent[] eventList
Returns
Type Description
CLResultCode
In this article
Back to top Generated by DocFX