cl_mem clCreateFromD3D11BufferKHR(cl_context context, cl_mem_flags flags, ID3D11Buffer *resource, cl_int *errcode_ret)
context - A valid OpenCL context created from a Direct3D 11 device.
flags - A bit-field that is used to specify usage information. May be
CL_MEM_READ_WRITE. (See the table for clCreateBuffer for more information.)
resource - A pointer to the Direct3D 11 buffer to share.
errcode_ret - An appropriate error code. If errcode_ret is NULL, no error code is returned.
The size of the returned OpenCL buffer object is the same as the size of resource. This call will increment the internal Direct3D reference count on resource. The internal Direct3D reference count on resource will be decremented when the OpenCL reference count on the returned OpenCL memory object drops to zero.
The goal of this extension is to provide interoperability between OpenCL and
Direct3D 11. This is designed to function analogously to the
cl_khr_gl_sharing 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
param_name for clGetDeviceInfo or clGetPlatformInfo.
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
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.
Returns a valid non-zero OpenCL buffer object and errcode_ret is set to
CL_SUCCESS if the buffer object is created successfully.
Otherwise, it returns a NULL value with one of the following error values returned in errcode_ret:
CL_INVALID_CONTEXTif context is not a valid context.
CL_INVALID_VALUEif values specified in flags are not valid.
CL_INVALID_D3D11_RESOURCE_KHRif resource is not a Direct3D 11 buffer resource, if resource was created with the
D3D11_USAGE_IMMUTABLE, if a
cl_memfrom resource has already been created using
clCreateFromD3D11BufferKHR, or if context was not created against the same Direct3D 11 device from which resource was created.
CL_OUT_OF_HOST_MEMORYif there is a failure to allocate resources required by the OpenCL implementation on the host.
For more information, see the OpenCL Extension Specification at URL
Copyright (c) 2014-2020 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.