blob: 83b155aaa793414b97cbf8cf6ae8d44f8f71790a [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_d3d11_sharing</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
<meta name="keywords" content="cl_khr_d3d11_sharing" />
</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="cl_khr_d3d11_sharing"></a>
<h1>cl_khr_d3d11_sharing</h1>
<p>
Provide interoperability between OpenCL and Direct3D 11.
</p>
</div>
<div class="refsect2">
<a id="synopsis"></a>
<h3>
</h3>
<div class="informaltable">
<table class="informaltable" border="0">
<colgroup>
<col align="left" class="col1" />
</colgroup>
<tbody>
<tr>
<td align="left">
#pragma OPENCL EXTENSION cl_khr_d3d11_sharing : enable
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1">
<a id="description"></a>
<h2>Description</h2>
<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 are provided in the header file
<code class="code">cl_d3d11.h</code>.
</p>
<p>
If the <code class="function">cl_khr_d3d11_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="clGetDeviceIDsFromD3D11KHR.html">
<span class="citerefentry">
<span class="refentrytitle">clGetDeviceIDsFromD3D11KHR</span>
</span>
</a>
</li>
<li class="listitem" style="list-style-type: disc">
<a class="citerefentry" href="clCreateFromD3D11BufferKHR.html">
<span class="citerefentry">
<span class="refentrytitle">clCreateFromD3D11BufferKHR</span>
</span>
</a>
</li>
<li class="listitem" style="list-style-type: disc">
<a class="citerefentry" href="clCreateFromD3D11Texture2DKHR.html">
<span class="citerefentry">
<span class="refentrytitle">clCreateFromD3D11Texture2DKHR</span>
</span>
</a>
</li>
<li class="listitem" style="list-style-type: disc">
<a class="citerefentry" href="clCreateFromD3D11Texture3DKHR.html">
<span class="citerefentry">
<span class="refentrytitle">clCreateFromD3D11Texture3DKHR</span>
</span>
</a>
</li>
<li class="listitem" style="list-style-type: disc">
<a class="citerefentry" href="clEnqueueAcquireD3D11ObjectsKHR.html">
<span class="citerefentry">
<span class="refentrytitle">clEnqueueAcquireD3D11ObjectsKHR</span>
</span>
</a>
</li>
<li class="listitem" style="list-style-type: disc">
<a class="citerefentry" href="clEnqueueReleaseD3D11ObjectsKHR.html">
<span class="citerefentry">
<span class="refentrytitle">clEnqueueReleaseD3D11ObjectsKHR</span>
</span>
</a>
</li>
</ul>
</div>
<p>
The OpenCL functions enabled by the <code class="function">cl_khr_d3d11_sharing</code> extension
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.5.7"></a>Lifetime of Shared [D3D11] 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>
</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=95" 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="clGetDeviceIDsFromD3D11KHR.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceIDsFromD3D11KHR</span></span></a>,
<a class="citerefentry" href="clCreateFromD3D11BufferKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D11BufferKHR</span></span></a>,
<a class="citerefentry" href="clCreateFromD3D11Texture2DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D11Texture2DKHR</span></span></a>,
<a class="citerefentry" href="clCreateFromD3D11Texture3DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D11Texture3DKHR</span></span></a>,
<a class="citerefentry" href="clEnqueueAcquireD3D10ObjectsKHR.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueAcquireD3D10ObjectsKHR</span></span></a>,
<a class="citerefentry" href="clEnqueueReleaseD3D11ObjectsKHR.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReleaseD3D11ObjectsKHR</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>