clCreateFromD3D11Texture2DKHR - Creates an OpenCL 2D image object from a subresource of a Direct3D 11 2D
Contents
Copyright
Copyright © 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.
Errors
Returns CL_SUCCESS 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
clCreateFromD3D11Texture2DKHR, 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 of Direct3D 11 and corresponding OpenCL image formats for
clCreateFromD3D11Texture3DKHR(3clc), 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.
Name
clCreateFromD3D11Texture2DKHR - Creates an OpenCL 2D image object from a subresource of a Direct3D 11 2D
texture.
cl_memclCreateFromD3D11Texture2DKHR(cl_contextcontext,cl_mem_flagsflags,ID3D11Texture2D*resource,UINTsubresource,cl_int*errcode_ret);Notes
1. OpenCL Specification
page 105, section 9.11.7.4 - Sharing Direct3D 11 Texture and Resources...
The Khronos Group 11/18/2024 CLCREATEFROMD3D11TEX(3clc)
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(3clc) for more information.)
resource
A pointer to the Direct3D 11 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.
See Also
cl_khr_d3d11_sharing(3clc), clGetDeviceIDsFromD3D11KHR(3clc), clCreateFromD3D11BufferKHR(3clc), clCreateFromD3D11Texture3DKHR(3clc), clEnqueueAcquireD3D11ObjectsKHR(3clc), clEnqueueReleaseD3D11ObjectsKHR(3clc)
Specification
OpenCLSpecification[1]
