blob: 7dcc0b3fca2210b4324cb776c2df494bf2acbad6 [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_gl_sharing</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
<meta name="keywords" content="cl_khr_gl_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_gl_sharing"></a>
<h1>cl_khr_gl_sharing</h1>
<p>
Allow applications to use OpenGL buffer, texture and renderbuffer objects as OpenCL memory objects.
</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">
cl_khr_gl_sharing
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1">
<a id="description"></a>
<h2>Description</h2>
<h4><a id="id-1.5.2"></a>OpenCL Functions That Allow Sharing</h4>
<p>
Click an item in the table for details about that function.
</p>
</div>
<div class="refsect1">
<a id="springboard"></a>
<h2></h2>
<div class="informaltable">
<table border="1">
<colgroup>
<col align="left" class="col1" />
<col align="left" class="col2" />
</colgroup>
<tbody>
<tr>
<td align="left">
<a class="citerefentry" href="clGetGLContextInfoKHR.html">
<span class="citerefentry">
<span class="refentrytitle">clGetGLContextInfoKHR</span>
</span>
</a>
</td>
<td align="left">Query the device.</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="clCreateFromGLBuffer.html">
<span class="citerefentry">
<span class="refentrytitle">clCreateFromGLBuffer</span>
</span>
</a>
</td>
<td align="left">Creates an OpenCL buffer object from an OpenGL buffer object.</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="clCreateFromGLTexture.html">
<span class="citerefentry">
<span class="refentrytitle">clCreateFromGLTexture</span>
</span>
</a>
</td>
<td align="left">Creates an OpenCL image object, image array object, or image buffer object from an OpenGL
texture object, texture array object, texture buffer object, or a single face of an
OpenGL cubemap texture object.</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="clCreateFromGLRenderbuffer.html">
<span class="citerefentry">
<span class="refentrytitle">clCreateFromGLRenderbuffer</span>
</span>
</a>
</td>
<td align="left">Creates an OpenCL 2D image object from an OpenGL renderbuffer object.</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="clGetGLObjectInfo.html">
<span class="citerefentry">
<span class="refentrytitle">clGetGLObjectInfo</span>
</span>
</a>
</td>
<td align="left">Query an OpenGL memory object used to create an OpenCL memory object.</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="clGetGLTextureInfo.html">
<span class="citerefentry">
<span class="refentrytitle">clGetGLTextureInfo</span>
</span>
</a>
</td>
<td align="left">Get additional information about the GL texture object associated with a memory object.</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="clEnqueueAcquireGLObjects.html">
<span class="citerefentry">
<span class="refentrytitle">clEnqueueAcquireGLObjects</span>
</span>
</a>
</td>
<td align="left">Acquire OpenCL memory objects that have been created from OpenGL objects.</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="clEnqueueReleaseGLObjects.html">
<span class="citerefentry">
<span class="refentrytitle">clEnqueueReleaseGLObjects</span>
</span>
</a>
</td>
<td align="left">Release OpenCL memory objects that have been created from OpenGL objects.</td>
</tr>
</tbody>
</table>
</div>
<p>
This is a Kronos-approved extension
name. If this extension is supported, "cl_khr_gl_sharing" will
be returned for <code class="constant">CL_DEVICE_EXTENSIONS</code> using
<a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</span></span></a>.
</p>
<p>
The OpenCL specification in section 9.7 defines how to
share data with texture and buffer objects in a parallel OpenGL implementation,
but does not define how the association between an OpenCL context and an OpenGL
context or share group is established. This extension defines optional attributes
to OpenCL context creation routines which associate a GL context or share group
object with a newly created OpenCL context. If this extension is supported
by an implementation, the string "cl_khr_gl_sharing" will be present in the
<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 in the <code class="constant">CL_PLATFORM_EXTENSIONS</code>
string described in the table of allowed values for <code class="varname">param_name</code>
for <a class="citerefentry" href="clGetPlatformInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetPlatformInfo</span></span></a>.
</p>
<p>
This section discusses OpenCL functions that allow applications
to use OpenGL buffer, texture, and renderbuffer objects as OpenCL memory objects. This
allows efficient sharing of data between OpenCL and OpenGL. The OpenCL API may be used
to execute kernels that read and/or write memory objects that are also OpenGL objects.
</p>
<p>
An OpenCL image object may be created from an OpenGL texture or
renderbuffer object. An OpenCL buffer object may be created from an OpenGL buffer object.
</p>
<p>
OpenCL memory objects may be created from OpenGL objects
if and only if the OpenCL context has been created from an OpenGL share group
object or context. OpenGL share groups and contexts are created using platform
specific APIs such as EGL, CGL, WGL, and GLX. On MacOS X, an OpenCL context may
be created from an OpenGL share group object using the OpenCL platform extension
cl_apple_gl_sharing. On other platforms including Microsoft Windows, Linux/Unix and
others, an OpenCL context may be created from an OpenGL context using the Khronos
platform extension <code class="function">cl_khr_gl_sharing</code>. Refer to the platform
documentation for your OpenCL implementation, or visit the Khronos Registry at
https://www.khronos.org/registry/cl/ for more information.
</p>
<p>
Any supported OpenGL object defined within the GL share
group object, or the share group associated with the GL context from which the CL
context is created, may be shared, with the exception of the default OpenGL objects
(i.e. objects named zero), which may not be shared.
</p>
<p>
If the <a class="citerefentry" href="cl_khr_mipmap_image.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_mipmap_image</span></span></a>
extension is supported by the OpenCL device, the
<code class="function">cl_khr_gl_sharing</code> extension adds support for creating a
mip-mapped CL image from a mip-mapped GL texture.
</p>
<p>
To create a mip-mapped CL image from a mip-mapped GL texture, the
<code class="varname">miplevel</code> argument to
<a class="citerefentry" href="clCreateFromGLTexture.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromGLTexture</span></span></a>
should be a negative value. If <code class="varname">miplevel</code> is a negative
value then a CL mipmapped image object is created from a mipmapped GL
texture object instead of a CL image object for a specific miplevel of a GL texture.
</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.0-extensions.pdf#page=37" 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="cl_khr_mipmap_image.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_mipmap_image</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-2013 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>