Skip to content

clCreateFromD3D10Texture2DKHR.adoc

Latest commit

 

History

History
83 lines (48 loc) · 3.18 KB

clCreateFromD3D10Texture2DKHR.adoc

File metadata and controls

83 lines (48 loc) · 3.18 KB

clCreateFromD3D10Texture2DKHR

Creates an OpenCL 2D image object from a subresource of a Direct3D 10 2D texture.

cl_mem clCreateFromD3D10Texture2DKHR(cl_context context,
                                     cl_mem_flags flags,
                                     ID3D10Texture2D *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 2D 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 2D image object are determined by the width, height and depth of subresource subresource of resource. The channel type and order of the returned OpenCL 2D image object is determined by the format of resource as shown in of Direct3D 10 and corresponding OpenCL image formats of resource in clCreateFromD3D10Texture3DKHR.

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.

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_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 a cl_mem from subresource subresource of resource has already been created using clCreateFromD3D10Texture2DKHR, 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 table of Direct3D 10 and corresponding OpenCL image formats for clCreateFromD3D10Texture3DKHR, 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.