clCreateFromD3D11Texture3DKHR

Creates an OpenCL 3D image object from a subresource of a Direct3D 11 3D texture.

`cl_mem clCreateFromD3D11Texture3DKHR(`	cl_context `context`,
	cl_mem_flags `flags`,
	ID3D11Texture3D `*resource`,
	UINT `subresource`,
	cl_int `*errcode_ret` `)`

Parameters

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_ONLY, CL_MEM_WRITE_ONLY, or CL_MEM_READ_WRITE. (See the table for clCreateBuffer for more information.)
resource: A pointer to the Direct3D 11 texture to share.
subresource: The subresource of resource to share.
errcode_ret: An appropriate error code. If errcode_ret is NULL, no error code is returned.

Notes

The width, height and depth of the returned OpenCL 3D image object are determined by the width, height and depth of subresource subresource of resource. The channel type and order of the returned OpenCL 3D image object is determined by the format of resource as shown in the table below (Table 9.9.3).

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.

DXGI format	CL image format (channel order, channel data type)
`DXGI_FORMAT_R32G32B32A32_FLOAT`	`CL_RGBA, CL_FLOAT`
`DXGI_FORMAT_R32G32B32A32_UINT`	`CL_RGBA, CL_UNSIGNED_INT32`
`DXGI_FORMAT_R32G32B32A32_SINT`	`CL_RGBA, CL_SIGNED_INT32`
`DXGI_FORMAT_R16G16B16A16_FLOAT`	`CL_RGBA, CL_HALF_FLOAT`
`DXGI_FORMAT_R16G16B16A16_UNORM`	`CL_RGBA, CL_UNORM_INT16`
`DXGI_FORMAT_R16G16B16A16_UINT`	`CL_RGBA, CL_UNSIGNED_INT16`
`DXGI_FORMAT_R16G16B16A16_SNORM`	`CL_RGBA, CL_SNORM_INT16`
`DXGI_FORMAT_R16G16B16A16_SINT`	`CL_RGBA, CL_SIGNED_INT16`
`DXGI_FORMAT_B8G8R8A8_UNORM`	`CL_BGRA, CL_UNORM_INT8`
`DXGI_FORMAT_R8G8B8A8_UNORM`	`CL_RGBA, CL_UNORM_INT8`
`DXGI_FORMAT_R8G8B8A8_UINT`	`CL_RGBA, CL_UNSIGNED_INT8`
`DXGI_FORMAT_R8G8B8A8_SNORM`	`CL_RGBA, CL_SNORM_INT8`
`DXGI_FORMAT_R8G8B8A8_SINT`	`CL_RGBA, CL_SIGNED_INT8`
`DXGI_FORMAT_R32G32_FLOAT`	`CL_RG, CL_FLOAT`
`DXGI_FORMAT_R32G32_UINT`	`CL_RG, CL_UNSIGNED_INT32`
`DXGI_FORMAT_R32G32_SINT`	`CL_RG, CL_SIGNED_INT32`
`DXGI_FORMAT_R16G16_FLOAT`	`CL_RG, CL_HALF_FLOAT`
`DXGI_FORMAT_R16G16_UNORM`	`CL_RG, CL_UNORM_INT16`
`DXGI_FORMAT_R16G16_UINT`	`CL_RG, CL_UNSIGNED_INT16`
`DXGI_FORMAT_R16G16_SNORM`	`CL_RG, CL_SNORM_INT16`
`DXGI_FORMAT_R16G16_SINT`	`CL_RG, CL_SIGNED_INT16`
`DXGI_FORMAT_R8G8_UNORM`	`CL_RG, CL_UNORM_INT8`
`DXGI_FORMAT_R8G8_UINT`	`CL_RG, CL_UNSIGNED_INT8`
`DXGI_FORMAT_R8G8_SNORM`	`CL_RG, CL_SNORM_INT8`
`DXGI_FORMAT_R8G8_SINT`	`CL_RG, CL_SIGNED_INT8`
`DXGI_FORMAT_R32_FLOAT`	`CL_R, CL_FLOAT`
`DXGI_FORMAT_R32_UINT`	`CL_R, CL_UNSIGNED_INT32`
`DXGI_FORMAT_R32_SINT`	`CL_R, CL_SIGNED_INT32`
`DXGI_FORMAT_R16_FLOAT`	`CL_R, CL_HALF_FLOAT`
`DXGI_FORMAT_R16_UNORM`	`CL_R, CL_UNORM_INT16`
`DXGI_FORMAT_R16_UINT`	`CL_R, CL_UNSIGNED_INT16`
`DXGI_FORMAT_R16_SNORM`	`CL_R, CL_SNORM_INT16`
`DXGI_FORMAT_R16_SINT`	`CL_R, CL_SIGNED_INT16`
`DXGI_FORMAT_R8_UNORM`	`CL_R, CL_UNORM_INT8`
`DXGI_FORMAT_R8_UINT`	`CL_R, CL_UNSIGNED_INT8`
`DXGI_FORMAT_R8_SNORM`	`CL_R, CL_SNORM_INT8`
`DXGI_FORMAT_R8_SINT`	`CL_R, CL_SIGNED_INT8`

Sharing Memory Objects with Direct3D 11 Resources

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_PLATFORM_EXTENSIONS or 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 cl_d3d11.h.

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.

Lifetime of Shared Objects

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.

Properties of Direct3D 11 objects may be queried using clGetMemObjectInfo and clGetImageInfo with param_name CL_MEM_D3D11_RESOURCE_KHR and CL_IMAGE_D3D11_SUBRESOURCE_KHR.

Errors

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 errcode_ret:

CL_INVALID_CONTEXT if context is not a valid context.
CL_INVALID_VALUE if values specified in flags are not valid or if subresource is not a valid subresource index for resource.
CL_INVALID_D3D11_RESOURCE_KHR if resource is not a Direct3D 11 texture resource, if resource was created with the D3D11_USAGE flag D3D11_USAGE_IMMUTABLE, if a resource is a multisampled texture, if cl_mem from subresource subresource of resource has already been created using clCreateFromD3D11Texture3DKHR, or if context was not created against the same Direct3D 11 device from which resource was created.
CL_INVALID_D3D11_RESOURCE_KHR if resource is not a Direct3D 11 texture object.
CL_INVALID_IMAGE_FORMAT_DESCRIPTOR if the Direct3D 11 texture format of resource is not a value listed in the table above of Direct3D 11 and corresponding OpenCL image formats, or if the Direct3D 11 texture format of resource does not map to a supported OpenCL image format.
CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host.

Specification

OpenCL Specification

Also see

cl_khr_d3d11_sharing

Copyright © 2007-2013 The Khronos Group Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or associated documentation files (the "Materials"), to deal in the Materials without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to the condition that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials.