blob: 82df677b1383f9840edc685e14f8e61a625c30db [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<style xmlns="" type="text/css">
/* This style sets a margin around the entire page */
html, body {
margin: 10px;
}
p {
font: normal 16px verdana, sans-serif;
margin: 0;
padding-bottom:12px;
}
h1 {
font: bold 25px verdana, sans-serif;
margin-top: 0;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
h2 {
font: bold 19px verdana, sans-serif;
margin-top: 28px;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
h3 {
font: bold 19px verdana, sans-serif !important;
margin-top: 28px;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
li {
font: normal 16px verdana, sans-serif;
margin-top: 0;
margin-bottom: 18px;
padding-top: 0;
padding-bottom: 0;
}
.pdparam {
font: italic 16px verdana, sans-serif;
}
.term {
font: italic 16px verdana, sans-serif;
font-weight: normal;
}
.type {
font: normal 16px verdana, sans-serif !important;
}
.parameter {
font-style: italic;
}
a:link, a:visited {
color: blue;
text-decoration: none;
font: normal 16px;
}
a:hover {
background-color: #FFFF99;
font: normal 16px;
}
div.funcsynopsis {
text-align: left;
background-color: #e6e6e6;
font: normal 16px verdana, sans-serif;
padding-top: 10px;
padding-bottom: 10px;
}
div.funcsynopsis table {
border-collapse: separate;
font: normal 16px verdana, sans-serif;
}
div.funcsynopsis td {
background-color: #e6e6e6;
border: 0 solid #000;
padding: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 {
font-family: verdana, sans-serif;
font-size: 16px;
}
code.constant {
font: normal 16px courier new, monospace !important;
}
span.errorname {
font: normal 16px verdana, sans-serif !important;
}
code.function {
font: bold 16px verdana, sans-serif !important;
}
b.fsfunc {
font: bold 16px verdana, sans-serif !important;
}
code.varname {
font: italic 16px verdana, sans-serif;
}
code.replaceable {
font: italic 16px courier new, monospace;
}
code.funcdef {
font: normal 16px verdana, sans-serif !important;
}
.citerefentry {
font: normal 16px verdana, sans-serif !important;
}
.parameter {
font-style: italic;
}
code.fsfunc {
font: normal 16px verdana, sans-serif !important;
}
/* PARAMETER: This style controls spacing between the terms in Parameter section */
dt {
margin-top: 15px;
}
/* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
div.refsect1 table {
width: 100%;
margin-top: 10px;
background-color: #FFF;
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 th {
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: bold 16px verdana, sans-serif;
}
div.refsect1 td {
background-color: #FFF;
padding: 5px;
vertical-align: text-top;
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 p{
font: normal 16px verdana, sans-serif;
margin-top: 8px;
margin-bottom: 8px;
padding-top: 0;
padding-bottom: 0;
}
/* EXAMPLE: These styles apply only to the Example section */
div.refsect2 {
font: normal 16px courier new, monospace !important;
}
div.refsect2 table {
margin-top: 0;
background-color: #e6e6e6;
width: 100%;
border: 0 solid #000;
padding: 2px;
font: normal 16px courier new, monospace !important;
}
div.refsect2 td {
background-color: #e6e6e6;
font: normal 16px courier new, monospace !important;
white-space:pre;
}
/* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
div.refsect3 {
font: normal 11px verdana, sans-serif;
margin-top: 50px;
margin-bottom: 20px;
padding-top: 0;
padding-bottom: 0;
}
</style>
<title>clGetDeviceIDsFromD3D11KHR</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
<meta name="keywords" content="clGetDeviceIDsFromD3D11KHR" />
</head>
<body>
<div class="refentry">
<a id="id-1"></a>
<div class="titlepage"></div>
<div xmlns="" class="refnamediv">
<a xmlns="http://www.w3.org/1999/xhtml" id="clGetDeviceIDsFromD3D10KHR"></a>
<h1>clGetDeviceIDsFromD3D11KHR</h1>
<p>Querying OpenCL Devices Corresponding to Direct3D 11 Devices.</p>
</div>
<div class="refsynopsisdiv">
<h2></h2>
<div class="funcsynopsis">
<table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
<tr valign="bottom">
<td>
<code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
<a class="link" href="scalarDataTypes.html" target="pagedisplay">cl_int</a>
<strong class="fsfunc">clGetDeviceIDsFromD3D11KHR</strong>
(</code>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_platform_id</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">platform</var>, </td>
</td>
</tr>
<tr valign="top">
<td> </td>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_d3d10_device_source_khr" target="pagedisplay">cl_d3d11_device_source_khr</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">d3d_device_source</var>, </td>
</tr>
<tr valign="top">
<td> </td>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">void</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*d3d_object</var>, </td>
</tr>
<tr valign="top">
<td> </td>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_d3d10_device_set_khr" target="pagedisplay">cl_d3d11_device_set_khr</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">d3d_device_set</var>, </td>
</tr>
<tr valign="top">
<td> </td>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_uint</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_entries</var>, </td>
</tr>
<tr valign="top">
<td> </td>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_device_id</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*devices</var>, </td>
</tr>
<tr valign="top">
<td> </td>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_uint</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*num_devices</var><code>)</code></td>
</tr>
</table>
</div>
</div>
<div class="refsect1">
<a id="parameters"></a>
<h2>Parameters</h2>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="varname">platform</code>
</span>
</dt>
<dd>
<p>
Refers to the platform ID returned by
<a class="citerefentry" href="clGetPlatformIDs.html"><span class="citerefentry"><span class="refentrytitle">clGetPlatformIDs</span></span></a>.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">d3d_device_source</code>
</span>
</dt>
<dd>
<p>
Specifies the type of <code class="varname">d3d_object</code> and may be one of the following (Table 9.11.1):
</p>
<div class="informaltable">
<table class="informaltable" border="1">
<colgroup>
<col align="left" class="col1" />
<col align="left" class="col2" />
</colgroup>
<thead>
<tr>
<th align="left">cl_d3d_device_source_khr</th>
<th align="left">Type of <code class="varname">d3d_object</code></th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code class="constant">CL_D3D11_DEVICE_KHR</code>
</td>
<td align="left">ID3D11Device *</td>
</tr>
<tr>
<td align="left">
<code class="constant">CL_D3D11_DXGI_ADAPTER_KHR</code>
</td>
<td align="left">IDXGIAdapter *</td>
</tr>
</tbody>
</table>
</div>
</dd>
<dt>
<span class="term">
<code class="varname">d3d_object</code>
</span>
</dt>
<dd>
<p>
Specifies the object whose corresponding OpenCL devices are being queried. The type of
<code class="varname">d3d_object</code> must be as specified in the table above.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">d3d_device_set</code>
</span>
</dt>
<dd>
<p>
Specifies the set of devices to return, and must be one of the following (Table 9.11.2):
</p>
<div class="informaltable">
<table class="informaltable" border="1">
<colgroup>
<col align="left" class="col1" />
<col align="left" class="col2" />
</colgroup>
<thead>
<tr>
<th align="left">cl_d3d_device_set_khr</th>
<th align="left">Devices returned in <code class="varname">devices</code></th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code class="constant">CL_PREFERRED_DEVICES_FOR_D3D11_KHR</code>
</td>
<td align="left">
The OpenCL devices associated with the specified Direct3D object.
</td>
</tr>
<tr>
<td align="left">
<code class="constant">CL_ALL_DEVICES_FOR_D3D11_KHR</code>
</td>
<td align="left">
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.
</td>
</tr>
</tbody>
</table>
</div>
</dd>
<dt>
<span class="term">
<code class="varname">num_entries</code>
</span>
</dt>
<dd>
<p>
The number of <span class="type">cl_device_id</span> entries that can be added to
<code class="varname">devices</code>. If <code class="varname">devices</code> is not NULL, the
<code class="varname">num_entries</code> must be greater than zero.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">devices</code>
</span>
</dt>
<dd>
<p>
Returns a list of OpenCL devices found. The <span class="type">cl_device_id</span> values
returned in <code class="varname">devices</code> can be used to identify a specific
OpenCL device. If <code class="varname">devices</code> is NULL, this argument is
ignored. The number of OpenCL devices returned is the mininum of the value
specified by <code class="varname">num_entries</code> and the number of OpenCL devices
corresponding to <code class="varname">d3d_object</code>.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">num_devices</code>
</span>
</dt>
<dd>
<p>
Returns the number of OpenCL devices available that correspond to
<code class="varname">d3d_object</code>. If <code class="varname">num_devices</code> is NULL,
this argument is ignored.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1">
<a id="description"></a>
<h2>Description</h2>
<p>
The OpenCL devices corresponding to a Direct3D 11 device may be queried. The OpenCL
devices corresponding to a DXGI adapter may also be queried. The OpenCL devices
corresponding to a Direct3D 11 device will be a subset of the OpenCL devices
corresponding to the DXGI adapter against which the Direct3D 11 device was created.
</p>
</div>
<div class="refsect1">
<a id="notes"></a>
<h2>Notes</h2>
<h4><a id="id-1.7.2"></a>Sharing Memory Objects with Direct3D 11 Resources</h4>
<p>
The goal of this extension is to provide interoperability between
OpenCL and Direct3D 11. This is designed to function analogously
to the <a class="citerefentry" href="cl_khr_gl_sharing.html"><span class="citerefentry"><span class="refentrytitle">OpenGL
interoperability</span></span></a> as defined in sections 9.7 and 9.8.
If this extension is supported by an implementation, the string "cl_khr_d3d11_sharing"
will be present in the <code class="constant">CL_PLATFORM_EXTENSIONS</code>
or <code class="constant">CL_DEVICE_EXTENSIONS</code> string described in
the table of allowed values for <code class="varname">param_name</code> for
<a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</span></span></a> or
<a class="citerefentry" href="clGetPlatformInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetPlatformInfo</span></span></a>.
</p>
<p>
As currently proposed the interfaces for this extension would be provided in
<code class="code">cl_d3d11.h</code>.
</p>
<p>
This section discusses OpenCL functions that allow
applications to use Direct3D 11 resources as OpenCL memory objects. This allows efficient
sharing of data between OpenCL and Direct3D 11. The OpenCL API may be used to execute
kernels that read and/or write memory objects that are also Direct3D 11 resources. An
OpenCL image object may be created from a Direct3D 11 texture resource. An OpenCL buffer
object may be created from a Direct3D 11 buffer resource. OpenCL memory objects may be
created from Direct3D 11 objects if and only if the OpenCL context has been created from
a Direct3D 11 device.
</p>
<h4><a id="id-1.7.6"></a>Lifetime of Shared Objects</h4>
<p>
An OpenCL memory object created from a
Direct3D 11 resource remains valid as long as the corresponding Direct3D 11 resource has
not been deleted. If the Direct3D 11 resource is deleted through the Direct3D 11 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.
</p>
<p>
The successful creation of a
cl_context against a Direct3D 11 device specified via the context create parameter
<code class="constant">CL_CONTEXT_D3D11_DEVICE_KHR</code> will increment the internal Direct3D
reference count on the specified Direct3D 11 device. The internal Direct3D reference
count on that Direct3D 11 device will be decremented when the OpenCL reference count on
the returned OpenCL context drops to zero.
</p>
<p>
The OpenCL context and corresponding command-queues are dependent on the
existence of the Direct3D 11 device from which the OpenCL context was created. If the
Direct3D 11 device is deleted through the Direct3D 11 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.
</p>
<p>
Properties of Direct3D 11 objects may be queried
using <a class="citerefentry" href="clGetMemObjectInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetMemObjectInfo</span></span></a>
and <a class="citerefentry" href="clGetImageInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetImageInfo</span></span></a>
with <code class="varname">param_name</code> <code class="constant">CL_MEM_D3D11_RESOURCE_KHR</code> and
<code class="constant">CL_IMAGE_D3D11_SUBRESOURCE_KHR</code>.
</p>
</div>
<div class="refsect1">
<a id="errors"></a>
<h2>Errors</h2>
<p>
Returns <span class="errorname">CL_SUCCESS</span> if the function is executed
successfully. Otherwise it may return:
</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_PLATFORM</span> if <code class="varname">platform</code> is not
a valid platform.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">d3d_device_source</code>
is not a valid value, <code class="varname">d3d_device_set</code> is not a valid value,
<code class="varname">num_entries</code> is equal to zero and <code class="varname">devices</code> is
not NULL, or if both <code class="varname">num_devices</code> and <code class="varname">devices</code>
are NULL.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_DEVICE_NOT_FOUND</span> if no OpenCL devices that correspond
to <code class="varname">d3d_object</code> were found.
</li>
</ul>
</div>
</div>
<div class="refsect1">
<a id="specification"></a>
<h2>Specification</h2>
<p><img src="pdficon_small1.gif" />
<a href="https://www.khronos.org/registry/cl/specs/opencl-2.1-extensions.pdf#page=100" target="OpenCL Spec">OpenCL Specification</a>
</p>
</div>
<div class="refsect1">
<a id="seealso"></a>
<h2>Also see</h2>
<p>
<a class="citerefentry" href="cl_khr_d3d11_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_d3d11_sharing</span></span></a>
</p>
</div>
<div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2015 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.
</div>
</div>
</body>
</html>