cl_mem
clCreateFromD3D10BufferKHR
(
| cl_context context, |
cl_mem_flags flags, | |
ID3D10Buffer *resource, | |
cl_int
*errcode_ret
) |
context
A valid OpenCL context created from a Direct3D 10 device.
flags
A bit-field that is used to specify usage information. May be
CL_MEM_READ_ONLY
, CL_MEM_WRITE_ONLY
,
or CL_MEM_READ_WRITE
. (See the table for
clCreateBuffer
for more information.)
resource
A pointer to the Direct3D 10 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.
General information about sharing memory objects with Direct3D 10 follows.
The goal of this extension is to provide
interoperability between OpenCL and Direct3D 10. This is designed to function
analogously to the OpenGL interoperability. If this extension is supported
by an implementation, the string "cl_khr_d3d10_sharing" will be present in the
CL_PLATFORM_EXTENSIONS
or CL_DEVICE_EXTENSIONS
string described in the table of allowed values for param_name
for
clGetDeviceInfo.
As currently proposed, the interfaces for this extension would be provided in cl_d3d10.h.
This section discusses OpenCL functions that allow applications to use Direct3D 10 resources as OpenCL memory objects. This allows efficient sharing of data between OpenCL and Direct3D 10. The OpenCL API may be used to execute kernels that read and/or write memory objects that are also Direct3D 10 resources. An OpenCL image object may be created from a Direct3D 10 texture resource. An OpenCL buffer object may be created from a Direct3D 10 buffer resource. OpenCL memory objects may be created from Direct3D 10 objects if and only if the OpenCL context has been created from a Direct3D 10 device.
An OpenCL memory object created from a Direct3D 10 resource remains valid as long as the corresponding Direct3D 10 resource has not been deleted. If the Direct3D 10 resource is deleted through the Direct3D 10 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 10 device specified via the context create parameter
CL_CONTEXT_D3D10_DEVICE_KHR
will increment the internal Direct3D
reference count on the specified Direct3D 10 device. The internal Direct3D reference
count on that Direct3D 10 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 10 device from which the OpenCL context was created. If the Direct3D 10 device is deleted through the Direct3D 10 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 CL_SUCCESS 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
:
context
is not a valid context.
flags
are
not valid.
resource
is not a Direct3D 10 buffer resource, if resource
was created with
the D3D10_USAGE
flag D3D10_USAGE_IMMUTABLE
,
if a cl_mem from resource has already been created using
clCreateFromD3D10BufferKHR
, or if context
was not created against the same Direct3D 10 device from which
resource
was created.
cl_khr_d3d10_sharing, clGetDeviceIDsFromD3D10KHR, clCreateFromD3D10Texture2DKHR, clCreateFromD3D10Texture3DKHR, clEnqueueAcquireD3D10ObjectsKHR, clEnqueueReleaseD3D10ObjectsKHR