clCreateFromD3D10Texture3DKHR
clCreateFromD3D10Texture3DKHR
2007-2011 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.
3
clCreateFromD3D10Texture3DKHR Creates an OpenCL 3D image object from a subresource of a Direct3D 10 3D texture.

##

cl_mem `clCreateFromD3D10Texture3DKHR` cl_context context cl_mem_flags flags ID3D10Texture3D*resource UINT subresource cl_int *errcode_ret

## Parameters

`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 3D 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 below in the table of Direct3D 10 and corresponding OpenCL image formats.

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.

Following is a list of Direct3D 10 and corresponding OpenCL image formats.

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_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

&sharingD3D10Inc;

## Errors

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

- 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_D3D10_RESOURCE_KHR if `resource` is not a Direct3D 10 texture resource, if `resource` was created with the `D3D10_USAGE` flag `D3D10_USAGE_IMMUTABLE`, if a `resource` is a multisampled texture, if cl_mem from subresource `subresource` of `resource` has already been created using `clCreateFromD3D10Texture3DKHR`, or if `context` was not created against the same Direct3D 10 device from which `resource` was created.
- CL_INVALID_IMAGE_FORMAT_DESCRIPTOR if the Direct3D 10 texture format of `resource` is not a value listed in the above table of Direct3D 10 and corresponding OpenCL image formats, or if the Direct3D 10 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_d3d10_sharing, clGetDeviceIDsFromD3D10KHR, clCreateFromD3D10BufferKHR, clCreateFromD3D10Texture2DKHR, clEnqueueAcquireD3D10ObjectsKHR, clEnqueueReleaseD3D10ObjectsKHR

##