Creates an OpenCL 2D image object from a subresource of a Direct3D 11 2D texture.
cl_mem clCreateFromD3D11Texture2DKHR(cl_context context, cl_mem_flags flags, ID3D11Texture2D *resource, UINT subresource, cl_int *errcode_ret)
A valid OpenCL context created from a Direct3D 11 device.
A bit-field that is used to specify usage information. May be
CL_MEM_READ_WRITE. (See the table for
clCreateBufferfor more information.)
A pointer to the Direct3D 11 2D texture to share.
The subresource of
An appropriate error code. If
errcode_retis NULL, no error code is returned.
The width, height and depth of the returned OpenCL 2D image object are determined by the width, height and depth of subresource
The channel type and order of the returned OpenCL 2D image object is determined by the format of
resource as shown in Direct3D 11 and corresponding OpenCL image formats of
This call will increment the internal Direct3D reference count on
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 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.
Returns a valid non-zero OpenCL image object and
errcode_ret is set to
CL_SUCCESS if the image object is created successfully.
Otherwise, it returns a NULL value with one of the following error values returned in
contextis not a valid context.
CL_INVALID_VALUEif values specified in
flagsare not valid or if
subresourceis not a valid subresource index for
resourceis not a Direct3D 11 texture resource, if
resourcewas created with the
D3D11_USAGE_IMMUTABLE, if a
resourceis a multisampled texture, if a
resourcehas already been created using
clCreateFromD3D11Texture2DKHR, or if
contextwas not created against the same Direct3D 11 device from which
CL_INVALID_IMAGE_FORMAT_DESCRIPTORif the Direct3D 11 texture format of
resourceis not a value listed in the table of Direct3D 11 and corresponding OpenCL image formats for
clCreateFromD3D11Texture3DKHR, or if the Direct3D 11 texture format of
resourcedoes not map to a supported OpenCL image format.
CL_OUT_OF_HOST_MEMORYif there is a failure to allocate resources required by the OpenCL implementation on the host.