blob: 3dfe4795ddcf080ea009629033128837add6e826 [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>clGetDeviceIDsFromDX9MediaAdapterKHR</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
<meta name="keywords" content="clGetDeviceIDsFromDX9MediaAdapterKHR" />
</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="clGetDeviceIDsFromDX9MediaAdapterKHR"></a>
<h1>clGetDeviceIDsFromDX9MediaAdapterKHR</h1>
<p>Query a media adapter for any associated OpenCL 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">clGetDeviceIDsFromDX9MediaAdapterKHR</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="scalarDataTypes.html" target="pagedisplay">cl_uint</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_media_adapters</var>, </td>
</tr>
<tr valign="top">
<td> </td>
<td>cl_dx9_media_adapter_type_khr <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*media_adapters_type</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">*media_adapters</var>, </td>
</tr>
<tr valign="top">
<td> </td>
<td>cl_dx9_media_adapter_set_khr <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">media_adapter_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_int</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">num_media_adapters</code>
</span>
</dt>
<dd>
<p>
Specifies the number of media adapters.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">media_adapters_type</code>
</span>
</dt>
<dd>
<p>
An array of <code class="varname">num_media_adapters</code> entries. Each entry specifies
the type of media adapter and must be one of the values described
in the table (Table 9.10.1) below.
</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_dx9_media_adapter_type_khr </th>
<th align="left">Type of media adapters</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code class="constant">CL_ADAPTER_D3D9_KHR</code>
</td>
<td align="left">IDirect3DDevice9 *</td>
</tr>
<tr>
<td align="left">
<code class="constant">CL_ADAPTER_D3D9EX_KHR</code>
</td>
<td align="left">IDirect3DDevice9Ex *</td>
</tr>
<tr>
<td align="left">
<code class="constant">CL_ADAPTER_DXVA_KHR</code>
</td>
<td align="left">IDXVAHD_Device *</td>
</tr>
</tbody>
</table>
</div>
</dd>
<dt>
<span class="term">
<code class="varname">media_adapters</code>
</span>
</dt>
<dd>
<p>
An array of <code class="varname">num_media_adapters</code> entries. Each
entry specifies the actual adapter whose type is specified by
<code class="varname">media_adapter_type</code>. The <code class="varname">media_adapters</code>
must be one of the types describes in the table above.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">media_adapter_set</code>
</span>
</dt>
<dd>
<p>
Specifies the set of adapters to return and must be one of the values described
in the table (Table 9.10.2) below.
</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_dx9_media_adapter_set_khr</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code class="constant">CL_PREFERRED_DEVICES_FOR_DX9_MEDIA_ADAPTER_KHR</code>
</td>
<td align="left">
The preferred OpenCL devices associated with the media adapter.
</td>
</tr>
<tr>
<td align="left">
<code class="constant">CL_ALL_DEVICES_FOR_DX9_MEDIA_ADAPTER_KHR</code>
</td>
<td align="left">
</td>
</tr>
<tr>
<td align="left">
<code class="constant">CL_ALL_DEVICES_FOR_MEDIA_DX9_ADAPTER_KHR</code>
</td>
<td align="left">
All OpenCL devices that may interoperate with the media adapter.
</td>
</tr>
</tbody>
</table>
</div>
</dd>
<dt>
<span class="term">
<code class="varname">num_entries</code>
</span>
</dt>
<dd>
<p>
The number of cl_device_id 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 that support the list of media adapters
specified. 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>
argument is NULL, this argument is ignored. The number of OpenCL devices returned
is the minimum of the value specified by <code class="varname">num_entries</code> or
the number of OpenCL devices whose type matches <code class="varname">device_type</code>.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">num_devices</code>
</span>
</dt>
<dd>
<p>
Returns the number of OpenCL devices. 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>
Queries a media adapter for any associated OpenCL devices. Adapters with associated
OpenCL devices can enable media surface sharing between the two.
</p>
</div>
<div class="refsect1">
<a id="notes"></a>
<h2>Notes</h2>
<p>
General information about sharing memory objects with DX9 follows.
</p>
<p>
The goal of this extension is to allow applications to use media surfaces as OpenCL memory
objects. This allows efficient sharing of data between OpenCL and selected adapter APIs (only
DX9 for now). If this extension is supported, an OpenCL image object can be created from a
media surface and the OpenCL API can be used to execute kernels that read and/or write
memory objects that are media surfaces. Note that OpenCL memory objects may be created
from the adapter media surface if and only if the OpenCL context has been created from that
adapter.
</p>
<p>
If this extension is supported by an implementation, the string "cl_khr_dx9_media_sharing"
will be present in the <code class="constant">CL_PLATFORM_EXTENSIONS</code>
(see <a class="citerefentry" href="clGetPlatformInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetPlatformInfo</span></span></a>)
or <code class="constant">CL_DEVICE_EXTENSIONS</code>
(see <a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</span></span></a>).
</p>
<p>
As currently proposed the interfaces for this extension would be provided in
<code class="code">cl_dx9_media_sharing.h</code>.
</p>
<h4><a id="id-1.7.6"></a>Surface formats for Media Surface Sharing</h4>
<p>
This section includes the D3D surface formats
that are supported when the adapter type is one of the Direct 3D lineage. Using a D3D
surface format not listed here is an error. To extend the use of this extension to support
media adapters beyond DirectX9 tables similar to the ones in this section will need to be
defined for the surface formats supported by the new media adapter. All implementations
that support this extension are required to support the NV12 surface format, the other
surface formats supported are the same surface formats that the adapter you are sharing
with supports as long as they are listed in the tables below (Tables 9.10.3 and 9.10.4).
</p>
<div class="informaltable">
<table class="informaltable" border="1">
<colgroup>
<col align="center" class="col1" />
<col align="center" class="col2" />
</colgroup>
<thead>
<tr>
<th align="center">FOUR CC code</th>
<th align="center">CL image format (channel order, channel data type)</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">FOURCC('N', 'V', '1', '2'), Plane 0</td>
<td align="center">
<code class="constant">CL_R, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">FOURCC('N', 'V', '1', '2'), Plane 1</td>
<td align="center">
<code class="constant">CL_RG, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">FOURCC('Y', 'V', '1', '2'), Plane 0</td>
<td align="center">
<code class="constant">CL_R, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">FOURCC('Y', 'V', '1', '2'), Plane 1</td>
<td align="center">
<code class="constant">CL_R, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">FOURCC('Y', 'V', '1', '2'), Plane 2</td>
<td align="center">
<code class="constant">CL_R, CL_UNORM_INT8</code>
</td>
</tr>
</tbody>
</table>
</div>
<p>
In the table above, NV12 Plane 0 corresponds to the luminance (Y) channel and Plane 1
corresponds to the UV channels. The YV12 Plane 0 corresponds to the Y channel, Plane
1 to the U channel and Plane 2 to the V channel. Note that the YUV formats map to
<code class="constant">CL_R</code> and <code class="constant">CL_RG</code> but do not perform any YUV to
RGB conversion and vice-versa.
</p>
<div class="informaltable">
<table class="informaltable" border="1">
<colgroup>
<col align="center" class="col1" />
<col align="center" class="col2" />
</colgroup>
<thead>
<tr>
<th align="center">D3D format</th>
<th align="center">CL image format (channel order, channel data type)</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">D3DFMT_R32F</td>
<td align="center">
<code class="constant">CL_R, CL_FLOAT</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_R16F</td>
<td align="center">
<code class="constant">CL_R, CL_HALF_FLOAT</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_L16</td>
<td align="center">
<code class="constant">CL_R, CL_UNORM_INT16</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_A8</td>
<td align="center">
<code class="constant">CL_A, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_L8</td>
<td align="center">
<code class="constant">CL_R, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_G32R32F</td>
<td align="center">
<code class="constant">CL_RG, CL_FLOAT</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_G16R16F</td>
<td align="center">
<code class="constant">CL_RG, CL_HALF_FLOAT</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_G16R16</td>
<td align="center">
<code class="constant">CL_RG, CL_UNORM_INT16</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_A8L8</td>
<td align="center">
<code class="constant">CL_RG, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_A32B32G32R32F</td>
<td align="center">
<code class="constant">CL_RGBA, CL_FLOAT</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_A16B16G16R16F</td>
<td align="center">
<code class="constant">CL_RGBA, CL_HALF_FLOAT</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_A16B16G16R16</td>
<td align="center">
<code class="constant">CL_RGBA, CL_UNORM_INT16</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_A8B8G8R8</td>
<td align="center">
<code class="constant">CL_RGBA, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_X8B8G8R8</td>
<td align="center">
<code class="constant">CL_RGBA, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_A8R8G8B8</td>
<td align="center">
<code class="constant">CL_BGRA, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_X8R8G8B8</td>
<td align="center">
<code class="constant">CL_BGRA, CL_UNORM_INT8</code>
</td>
</tr>
</tbody>
</table>
</div>
<p>
Note that D3D9 format names seem to imply that the order of the color channels are switched
relative to OpenCL but this is not the case. For example, layout of channels for each pixel
for <code class="constant">D3DFMT_A32FB32FG32FR32F</code> is the same as
<code class="constant">CL_RGBA</code>, <code class="constant">CL_FLOAT</code>.
</p>
<p>
Properties of media surface 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_DX9_MEDIA_ADAPTER_TYPE_KHR</code>,
<code class="constant">CL_MEM_DX9_MEDIA_SURFACE_INFO_KHR</code> and
<code class="constant">CL_IMAGE_DX9_MEDIA_SURFACE_PLANE_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 returns one of the following errors:
</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">num_media_adapters</code>
is zero or if <code class="varname">media_adapters_type</code> is NULL or if
<code class="varname">media_adapters</code> is NULL.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if any of the entries in
<code class="varname">media_adapters_type</code> or <code class="varname">media_adapters</code>
is not a valid value.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">media_adapter_set</code>
is not a valid value.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <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 adapters specified in <code class="varname">media_adapters</code> and
<code class="varname">media_adapters_type</code> were found.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_RESOURCES</span> if there is a failure to allocate
resources required by the OpenCL implementation on the device.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_HOST_MEMORY</span> if there is a failure to allocate
resources required by the OpenCL implementation on the host.
</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=85" 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_dx9_media_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_dx9_media_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>