'\" t
.\"     Title: clGetDeviceIDsFromD3D10KHR
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 02/03/2019
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "CLGETDEVICEIDSFROMD3" "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"
clGetDeviceIDsFromD3D10KHR \- Querying OpenCL Devices Corresponding to Direct3D 10 Devices\&.
.SH ""
.HP \w'cl_int\ clGetDeviceIDsFromD3D10KHR('u
.BI "cl_int clGetDeviceIDsFromD3D10KHR(cl_platform_id\ " "platform" ", cl_d3d10_device_source_khr\ " "d3d_device_source" ", void\ *" "d3d_object" ", cl_d3d10_device_set_khr\ " "d3d_device_set" ", cl_uint\ " "num_entries" ", cl_device_id\ *" "devices" ", cl_uint\ *" "num_devices" ");"
.SH "PARAMETERS"
.PP
\fIplatform\fR
.RS 4
Refers to the platform ID returned by
\fBclGetPlatformIDs\fR(3clc)\&.
.RE
.PP
\fId3d_device_source\fR
.RS 4
Specifies the type of
\fId3d_object\fR
and may be one of the following:\&.
.TS
allbox tab(:);
lB lB.
T{
cl_d3d_device_source_khr
T}:T{
Type of \fId3d_object\fR
T}
.T&
l l
l l.
T{
\fBCL_D3D10_DEVICE_KHR\fR
T}:T{
\fBID3D10Device\fR *
T}
T{
\fBCL_D3D10_DXGI_ADAPTER_KHR\fR
T}:T{
\fBIDXGIAdapter\fR *
T}
.TE
.sp 1
.RE
.PP
\fId3d_object\fR
.RS 4
Specifies the object whose corresponding OpenCL devices are being queried\&. The type of
\fId3d_object\fR
must be as specified in the table above\&.
.RE
.PP
\fId3d_device_set\fR
.RS 4
Specifies the set of devices to return, and must be one of the following:
.TS
allbox tab(:);
lB lB.
T{
cl_d3d_device_set_khr
T}:T{
Devices returned in \fIdevices\fR
T}
.T&
l l
l l.
T{
\fBCL_PREFERRED_DEVICES_FOR_D3D10_KHR\fR
T}:T{
The OpenCL devices associated with the specified Direct3D object\&.
T}
T{
\fBCL_ALL_DEVICES_FOR_D3D10_KHR\fR
T}:T{
All OpenCL devices which may interoperate with the specified
Direct3D object\&.  Performance of sharing data on these devices
may be considerably less than on the preferred devices\&.
T}
.TE
.sp 1
.RE
.PP
\fInum_entries\fR
.RS 4
The number of
\fBcl_device_id\fR
entries that can be added to
\fIdevices\fR\&. If
\fIdevices\fR
is not NULL, the
\fInum_entries\fR
must be greater than zero\&.
.RE
.PP
\fIdevices\fR
.RS 4
Returns a list of OpenCL devices found\&. The cl_device_id values returned in
\fIdevices\fR
can be used to identify a specific OpenCL device\&. If
\fIdevices\fR
is NULL, this argument is ignored\&. The number of OpenCL devices returned is the mininum of the value specified by
\fInum_entries\fR
and the number of OpenCL devices corresponding to
\fId3d_object\fR\&.
.RE
.PP
\fInum_devices\fR
.RS 4
Returns the number of OpenCL devices available that correspond to
\fId3d_object\fR\&. If
\fInum_devices\fR
is NULL, this argument is ignored\&.
.RE
.SH "DESCRIPTION"
.PP
The OpenCL devices corresponding to a Direct3D 10 device may be queried\&. The OpenCL devices corresponding to a DXGI adapter may also be queried\&. The OpenCL devices corresponding to a Direct3D 10 device will be a subset of the OpenCL devices corresponding to the DXGI adapter against which the Direct3D 10 device was created\&.
.SH "NOTES"
.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
if the function is executed successfully\&. Otherwise it may return:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_PLATFORM if \fIplatform\fR is not
a valid platform\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if \fId3d_device_source\fR
is not a valid value, \fId3d_device_set\fR is not a valid value,
\fInum_entries\fR is equal to zero and \fIdevices\fR is
not NULL, or if both \fInum_devices\fR and \fIdevices\fR
are NULL\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_DEVICE_NOT_FOUND if no OpenCL devices that correspond
to \fId3d_object\fR were found\&.
.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),
\fBclCreateFromD3D10BufferKHR\fR(3clc),
\fBclCreateFromD3D10Texture2DKHR\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 71, section 9.9.7.1 - Querying OpenCL Devices Corresponding to... 11...
.RE