'\" t .\" Title: clCreateFromD3D10Texture2DKHR .\" Author: The Khronos Group .\" Generator: DocBook XSL Stylesheets v1.79.1 .\" Date: 02/03/2019 .\" Manual: OpenCL Manual .\" Source: The Khronos Group .\" Language: English .\" .TH "CLCREATEFROMD3D10TEX" "3clc" "02/03/2019" "The Khronos Group" "OpenCL Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" clCreateFromD3D10Texture2DKHR \- Creates an OpenCL 2D image object from a subresource of a Direct3D 10 2D texture\&. .SH "" .HP \w'cl_mem\ clCreateFromD3D10Texture2DKHR('u .BI "cl_mem clCreateFromD3D10Texture2DKHR(cl_context\ " "context" ", cl_mem_flags\ " "flags" ", ID3D10Texture2D\ *" "resource" ", UINT\ " "subresource" ", cl_int\ *" "errcode_ret" ");" .SH "PARAMETERS" .PP \fIcontext\fR .RS 4 A valid OpenCL context created from a Direct3D 10 device\&. .RE .PP \fIflags\fR .RS 4 A bit\-field that is used to specify usage information\&. May be \fBCL_MEM_READ_ONLY\fR, \fBCL_MEM_WRITE_ONLY\fR, or \fBCL_MEM_READ_WRITE\fR\&. (See the table for \fBclCreateBuffer\fR(3clc) for more information\&.) .RE .PP \fIresource\fR .RS 4 A pointer to the Direct3D 10 2D texture to share\&. .RE .PP \fIsubresource\fR .RS 4 The subresource of \fIresource\fR to share\&. .RE .PP \fIerrcode_ret\fR .RS 4 An appropriate error code\&. If \fIerrcode_ret\fR is NULL, no error code is returned\&. .RE .SH "NOTES" .PP The width, height and depth of the returned OpenCL 2D image object are determined by the width, height and depth of subresource \fIsubresource\fR of \fIresource\fR\&. The channel type and order of the returned OpenCL 2D image object is determined by the format of \fIresource\fR as shown in of Direct3D 10 and corresponding OpenCL image formats of \fIresource\fR in \fBclCreateFromD3D10Texture3DKHR\fR(3clc)\&. .PP This call will increment the internal Direct3D reference count on \fIresource\fR\&. The internal Direct3D reference count on \fIresource\fR will be decremented when the OpenCL reference count on the returned OpenCL memory object drops to zero\&. .PP General information about sharing memory objects with Direct3D 10 follows\&. .PP 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 \fBCL_PLATFORM_EXTENSIONS\fR or \fBCL_DEVICE_EXTENSIONS\fR string described in the table of allowed values for \fIparam_name\fR for \fBclGetDeviceInfo\fR(3clc)\&. .PP As currently proposed, the interfaces for this extension would be provided in cl_d3d10\&.h\&. .PP 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\&. Lifetime of Shared Objects.PP 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\&. .PP The successful creation of a cl_context against a Direct3D 10 device specified via the context create parameter \fBCL_CONTEXT_D3D10_DEVICE_KHR\fR 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\&. .PP 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\&. .SH "ERRORS" .PP Returns CL_SUCCESS returns a valid non\-zero OpenCL image object and \fIerrcode_ret\fR 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 \fIerrcode_ret\fR: .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} CL_INVALID_CONTEXT if \fIcontext\fR is not a valid context\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} CL_INVALID_VALUE if values specified in \fIflags\fR are not valid or if \fIsubresource\fR is not a valid subresource index for \fIresource\fR\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} CL_INVALID_D3D10_RESOURCE_KHR if \fIresource\fR is not a Direct3D 10 texture resource, if \fIresource\fR was created with the D3D10_USAGE flag D3D10_USAGE_IMMUTABLE, if a \fIresource\fR is a multisampled texture, if cl_mem from subresource \fIsubresource\fR of \fIresource\fR has already been created using \fBclCreateFromD3D10Texture2DKHR\fR, or if \fIcontext\fR was not created against the same Direct3D 10 device from which \fIresource\fR was created\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} CL_INVALID_IMAGE_FORMAT_DESCRIPTOR if the Direct3D 10 texture format of \fIresource\fR is not a value listed in the table of Direct3D 10 and corresponding OpenCL image formats for \fBclCreateFromD3D10Texture3DKHR\fR(3clc), or if the Direct3D 10 texture format of \fIresource\fR does not map to a supported OpenCL image format\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host\&. .RE .SH "SPECIFICATION" .PP \m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2 .SH "SEE ALSO" .PP \fBcl_khr_d3d10_sharing\fR(3clc), \fBclGetDeviceIDsFromD3D10KHR\fR(3clc), \fBclCreateFromD3D10BufferKHR\fR(3clc), \fBclCreateFromD3D10Texture3DKHR\fR(3clc), \fBclEnqueueAcquireD3D10ObjectsKHR\fR(3clc), \fBclEnqueueReleaseD3D10ObjectsKHR\fR(3clc) .SH "AUTHORS" .PP \fBThe Khronos Group\fR .SH "COPYRIGHT" .br Copyright \(co 2007-2011 The Khronos Group Inc. .br 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. .sp .SH "NOTES" .IP " 1." 4 OpenCL Specification .RS 4 \%page 74, section 9.9.7.4 - Sharing Direct3D 10 Texture and Resources... .RE