blob: 49897079ea369b2718ee23236678ba5df8a1a7fe [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>cl_khr_d3d10_sharing</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
<meta name="keywords" content="cl_khr_d3d10_sharing" />
</head>
<body>
<div class="refentry">
<a id="idm5827232"></a>
<div class="titlepage"></div>
<div xmlns="" class="refnamediv">
<a xmlns="http://www.w3.org/1999/xhtml" id="cl_khr_d3d10_sharing"></a>
<h1>cl_khr_d3d10_sharing</h1>
<p>
Provide interoperability between OpenCL and Direct3D 10.
</p>
</div>
<div class="refsect2">
<a id="synopsis"></a>
<h3>
</h3>
<div class="informaltable">
<table border="0">
<colgroup>
<col align="left" class="col1" />
</colgroup>
<tbody>
<tr>
<td align="left">
#pragma OPENCL EXTENSION cl_khr_d3d10_sharing : enable
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1">
<a id="description"></a>
<h2>Description</h2>
<p>
The interfaces for this extension are provided in the header file <code class="code">cl_d3d10.h</code>.
</p>
<p>
If the <code class="function">cl_khr_d3d10_sharing</code> extension is supported, then the following functions
are enabled:
</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem" style="list-style-type: disc">
<a class="citerefentry" href="clGetDeviceIDsFromD3D10KHR.html">
<span class="citerefentry">
<span class="refentrytitle">clGetDeviceIDsFromD3D10KHR</span>
</span>
</a>
</li>
<li class="listitem" style="list-style-type: disc">
<a class="citerefentry" href="clCreateFromD3D10BufferKHR.html">
<span class="citerefentry">
<span class="refentrytitle">clCreateFromD3D10BufferKHR</span>
</span>
</a>
</li>
<li class="listitem" style="list-style-type: disc">
<a class="citerefentry" href="clCreateFromD3D10Texture2DKHR.html">
<span class="citerefentry">
<span class="refentrytitle">clCreateFromD3D10Texture2DKHR</span>
</span>
</a>
</li>
<li class="listitem" style="list-style-type: disc">
<a class="citerefentry" href="clCreateFromD3D10Texture3DKHR.html">
<span class="citerefentry">
<span class="refentrytitle">clCreateFromD3D10Texture3DKHR</span>
</span>
</a>
</li>
<li class="listitem" style="list-style-type: disc">
<a class="citerefentry" href="clEnqueueAcquireD3D10ObjectsKHR.html">
<span class="citerefentry">
<span class="refentrytitle">clEnqueueAcquireD3D10ObjectsKHR</span>
</span>
</a>
</li>
<li class="listitem" style="list-style-type: disc">
<a class="citerefentry" href="clEnqueueReleaseD3D10ObjectsKHR.html">
<span class="citerefentry">
<span class="refentrytitle">clEnqueueReleaseD3D10ObjectsKHR</span>
</span>
</a>
</li>
</ul>
</div>
<p>
The OpenCL functions enabled by the <code class="function">cl_khr_d3d10_sharing</code> extension 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.
</p>
<p>
When the <code class="function">cl_khr_d3d10_sharing</code> extension is enabled, this extends the list of allowable
values in certain parameters of certain functions, as follows:
</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem" style="list-style-type: disc"><code class="code">CL_CONTEXT_D3D10_DEVICE_KHR</code> is accepted as a property name in the <code class="varname">properties</code>
parameter of <a class="citerefentry" href="clCreateContext.html"><span class="citerefentry"><span class="refentrytitle">clCreateContext</span></span></a> and
<a class="citerefentry" href="clCreateContextFromType.html"><span class="citerefentry"><span class="refentrytitle">clCreateContextFromType</span></span></a>.
</li>
<li class="listitem" style="list-style-type: disc"><code class="code">CL_CONTEXT_D3D10_PREFER_SHARED_RESOURCES_KHR</code> is accepted as a value in the
<code class="varname">param_name</code> parameter of
<a class="citerefentry" href="clGetContextInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetContextInfo</span></span></a>.
</li>
<li class="listitem" style="list-style-type: disc"><code class="code">CL_MEM_D3D10_RESOURCE_KHR</code> is accepted as a value in the
<code class="varname">param_name</code> parameter of
<a class="citerefentry" href="clGetMemObjectInf.html"><span class="citerefentry"><span class="refentrytitle">clGetMemObjectInf</span></span></a>.
</li>
<li class="listitem" style="list-style-type: disc"><code class="code">CL_IMAGE_D3D10_SUBRESOURCE_KHR</code> is accepted as a value in the
<code class="varname">param_name</code> parameter of
<a class="citerefentry" href="clGetImageInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetImageInfo</span></span></a>.
</li>
<li class="listitem" style="list-style-type: disc"><code class="code">CL_COMMAND_ACQUIRE_D3D10_OBJECTS_KHR</code> and <code class="code">CL_COMMAND_RELEASE_D3D10_OBJECTS_KHR</code>
are returned in the <code class="varname">param_value</code> parameter of
<a class="citerefentry" href="clGetEventInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetEventInfo</span></span></a> when <code class="varname">param_name</code>
is <code class="code">CL_EVENT_COMMAND_TYPE</code>.
</li>
<li class="listitem" style="list-style-type: disc"><code class="code">CL_INVALID_D3D10_DEVICE_KHR</code> is returned by
<a class="citerefentry" href="clCreateContext.html"><span class="citerefentry"><span class="refentrytitle">clCreateContext</span></span></a> and
<a class="citerefentry" href="clCreateContextFromType.html"><span class="citerefentry"><span class="refentrytitle">clCreateContextFromType</span></span></a> if the Direct3D 10
device specified for interoperability is not compatible with the devices against which the context is to
be created.
</li>
<li class="listitem" style="list-style-type: disc"><code class="code">CL_INVALID_D3D10_RESOURCE_KHR</code> is returned by
<a class="citerefentry" href="clCreateFromD3D10BufferKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D10BufferKHR</span></span></a> when resource is
not a Direct3D 10 buffer object, and by
<a class="citerefentry" href="clCreateFromD3D10Texture2DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D10Texture2DKHR</span></span></a> and
<a class="citerefentry" href="clCreateFromD3D10Texture3DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D10Texture3DKHR</span></span></a> when
resource is not a Direct3D 10 texture object.
</li>
<li class="listitem" style="list-style-type: disc"><code class="code">CL_D3D10_RESOURCE_ALREADY_ACQUIRED_KHR</code> is returned by
<a class="citerefentry" href="clEnqueueAcquireD3D10ObjectsKHR.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueAcquireD3D10ObjectsKHR</span></span></a> when
any of mem_objects are currently acquired by OpenCL.
</li>
<li class="listitem" style="list-style-type: disc"><code class="code">CL_D3D10_RESOURCE_NOT_ACQUIRED_KHR</code> is returned by
<a class="citerefentry" href="clEnqueueReleaseD3D10ObjectsKHR.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReleaseD3D10ObjectsKHR</span></span></a> when
any of mem_objects are not currently acquired by OpenCL.
</li>
</ul>
</div>
</div>
<div class="refsect1">
<a id="specification"></a>
<h2>Specification</h2>
<p>
<img src="pdficon_small1.gif" />
<a href="http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf#page=329" target="OpenCL Spec">OpenCL Specification</a>
</p>
</div>
<div class="refsect1">
<a id="seealso"></a>
<h2>Also see</h2>
<p>
<a class="citerefentry" href="EXTENSION.html"><span class="citerefentry"><span class="refentrytitle">EXTENSION</span></span></a>,
<a class="citerefentry" href="clGetDeviceIDsFromD3D10KHR.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceIDsFromD3D10KHR</span></span></a>,
<a class="citerefentry" href="clCreateFromD3D10BufferKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D10BufferKHR</span></span></a>,
<a class="citerefentry" href="clCreateFromD3D10Texture2DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D10Texture2DKHR</span></span></a>,
<a class="citerefentry" href="clCreateFromD3D10Texture3DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D10Texture3DKHR</span></span></a>,
<a class="citerefentry" href="clEnqueueAcquireD3D10ObjectsKHR.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueAcquireD3D10ObjectsKHR</span></span></a>,
<a class="citerefentry" href="clEnqueueReleaseD3D10ObjectsKHR.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReleaseD3D10ObjectsKHR</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-2010 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>