Acquire OpenCL memory objects that have been created from Direct3D 11 resources
cl_int clEnqueueAcquireD3D11ObjectsKHR(cl_command_queue command_queue, cl_uint num_objects, const cl_mem *mem_objects, cl_uint num_events_in_wait_list, const cl_event *event_wait_list, cl_event *event)
A valid command-queue.
The number of memory objects to be acquired in
A pointer to a list of OpenCL memory objects that were created from Direct3D 11 resources.
Specify events that need to complete before this particular command can be executed. If
event_wait_listis NULL, then this particular command does not wait on any event to complete. If
num_events_in_wait_listmust be 0. If
event_wait_listis not NULL, the list of events pointed to by
event_wait_listmust be valid and
num_events_in_wait_listmust be greater than 0. The events specified in
event_wait_listact as synchronization points.
Returns an event object that identifies this particular command and can be used to query or queue a wait for this particular command to complete.
eventcan be NULL in which case it will not be possible for the application to query the status of this command or queue a wait for this command to complete. If the
eventarguments are not NULL, the
eventargument should not refer to an element of the
The Direct3D 11 objects are acquired by the OpenCL context associated with
command-queue and can therefore be used by all command-queues associated with the OpenCL context.
OpenCL memory objects created from Direct3D 11 resources must be acquired before they can be used by any OpenCL commands queued to a command-queue.
If an OpenCL memory object created from a Direct3D 11 resource is used while it is not currently acquired by OpenCL, the call attempting to use that OpenCL memory object will return
CL_CONTEXT_INTEROP_USER_SYNC is not specified as
CL_TRUE during context creation,
clEnqueueAcquireD3D11ObjectsKHR provides the synchronization guarantee that any Direct3D 11 calls involving the interop device(s) used in the OpenCL context made before
clEnqueueAcquireD3D11ObjectsKHR is called will complete executing before
event reports completion and before the execution of any subsequent OpenCL work issued in
If the context was created with properties specifying
CL_TRUE, the user is responsible for guaranteeing that any Direct3D 11 calls involving the interop device(s) used in the OpenCL context made before
clEnqueueAcquireD3D11ObjectsKHR is called have completed before calling
The goal of this extension is to provide interoperability between OpenCL and Direct3D 11.
This is designed to function analogously to the OpenGL interoperability as defined in sections 9.7 and 9.8.
If this extension is supported by an implementation, the string "cl_khr_d3d11_sharing" will be present in the
CL_DEVICE_EXTENSIONS string described in the table of allowed values for
As currently proposed the interfaces for this extension would be provided in
This section discusses OpenCL functions that allow applications to use Direct3D 11 resources as OpenCL memory objects. This allows efficient sharing of data between OpenCL and Direct3D 11. The OpenCL API may be used to execute kernels that read and/or write memory objects that are also Direct3D 11 resources. An OpenCL image object may be created from a Direct3D 11 texture resource. An OpenCL buffer object may be created from a Direct3D 11 buffer resource. OpenCL memory objects may be created from Direct3D 11 objects if and only if the OpenCL context has been created from a Direct3D 11 device.
An OpenCL memory object created from a Direct3D 11 resource remains valid as long as the corresponding Direct3D 11 resource has not been deleted. If the Direct3D 11 resource is deleted through the Direct3D 11 API, subsequent use of the OpenCL memory object will result in undefined behavior, including but not limited to possible OpenCL errors, data corruption, and program termination.
The successful creation of a cl_context against a Direct3D 11 device specified via the context create parameter
CL_CONTEXT_D3D11_DEVICE_KHR will increment the internal Direct3D reference count on the specified Direct3D 11 device.
The internal Direct3D reference count on that Direct3D 11 device will be decremented when the OpenCL reference count on the returned OpenCL context drops to zero.
The OpenCL context and corresponding command-queues are dependent on the existence of the Direct3D 11 device from which the OpenCL context was created. If the Direct3D 11 device is deleted through the Direct3D 11 API, subsequent use of the OpenCL context will result in undefined behavior, including but not limited to possible OpenCL errors, data corruption, and program termination.
CL_SUCCESS if the function is executed successfully.
num_objects is 0 and
mem_objects is NULL then the function does nothing and returns
Otherwise it returns one of the following errors:
num_objectsis zero and
mem_objectsis not a NULL value or if
num_objects> 0 and
CL_INVALID_MEM_OBJECTif memory objects in
mem_objectsare not valid OpenCL memory objects or if memory objects in
mem_objectshave not been created from Direct3D 11 resources.
command_queueis not a valid command-queue.
CL_INVALID_CONTEXTif context associated with
command_queuewas not created from a Direct3D 11 context.
CL_D3D11_RESOURCE_ALREADY_ACQUIRED_KHRif memory objects in
mem_objectshave previously been acquired using
clEnqueueAcquireD3D11ObjectsKHRbut have not been released using
CL_D3D11_RESOURCE_ALREADY_ACQUIRED_KHRwhen any of
mem_objectsare currently acquired by OpenCL.
event_wait_listis NULL and
num_event_in_wait_list> 0, or
event_wait_listis not NULL and
num_event_in_wait_listis 0, or if event objects in
event_wait_listare not valid events.
CL_OUT_OF_HOST_MEMORYif there is a failure to allocate resources required by the OpenCL implementation on the host.