sdk/2.1/docs/man/cl_khr_gl_sharing.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd" [
<!ENTITY gl_sharingInc SYSTEM "gl_sharingInc.xml">
]>

<refentry>
    <refentryinfo>
        <keywordset>
            <keyword>cl_khr_gl_sharing</keyword>
        </keywordset>
    </refentryinfo>

    <refmeta>
        <refentrytitle>cl_khr_gl_sharing</refentrytitle>

        <refmiscinfo>
            <copyright>
                <year>2007-2013</year>
                <holder>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.</holder>
            </copyright>
        </refmiscinfo>
        <manvolnum>3</manvolnum>
    </refmeta>

<!-- ================================ SYNOPSIS -->

    <refnamediv id="cl_khr_gl_sharing">
        <refname>cl_khr_gl_sharing</refname>

        <refpurpose>
Allow applications to use OpenGL buffer, texture and renderbuffer objects as OpenCL memory objects.
        </refpurpose>
    </refnamediv>

    <!-- ALTERNATIVE SYNTAX SYNOPSIS (NON-FUNCTION) -->

    <refsect2 id="synopsis">
        <title>
        </title>

        <informaltable frame="none">
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
                <colspec colname="col1" colnum="1" />
                <tbody>
                    <row>
                        <entry>
cl_khr_gl_sharing
                        </entry>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect2>

<!-- ================================ DESCRIPTION  -->

    <refsect1 xmlns:xlink="http://www.w3.org/1999/xlink" id="description"><title>Description</title>

        &gl_sharingInc;

    </refsect1>

<!-- ================================ NOTES  -->

    <refsect1 id="notes"><title>Notes</title>
        <para>
            If the 
            <citerefentry><refentrytitle>cl_khr_mipmap_image</refentrytitle></citerefentry>,
            extension is supported by the OpenCL device, the
            <function>cl_khr_gl_sharing</function>
            extension adds support for creating a mip-mapped CL image from a
            mip-mapped GL texture.
        </para>

        <para>
            To create a mip-mapped CL image from a mip-mapped GL texture, the 
            <varname>miplevel</varname> argument to
            <citerefentry><refentrytitle>clCreateFromGLTexture</refentrytitle></citerefentry>,
            should be a negative value. If 
            <varname>miplevel</varname> 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.
        </para>

        <para>
            NOTE: For a detailed description of how the level of 
            detail is computed, please refer to section
            3.9.7 of the OpenGL 3.0 specification.
        </para>
    </refsect1>

<!-- ================================ EXAMPLE  -->

<!-- ================================ EXAMPLE  -->
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
<!--
    <refsect2 id="example1">
        <title>
            Example
        </title>

        <informaltable frame="none">
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
                <colspec colname="col1" colnum="1" />
                <tbody>
                    <row>
                        <entry>
                            Example goes here - it will be set in "code" type with white space preserved.
                        </entry>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect2>
-->

<!-- ================================ SPECIFICATION  -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
-->
    <refsect1 id="specification"><title>Specification</title>
        <para>
            <imageobject>
                <imagedata fileref="pdficon_small1.gif" format="gif" />
            </imageobject>

            <olink uri="cl_khr_gl_sharing">OpenCL Specification</olink>
        </para>
    </refsect1>

<!-- ================================ ALSO SEE -->

    <refsect1 id="seealso"><title>Also see</title>
        <para>
            <citerefentry><refentrytitle>EXTENSION</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>clGetGLContextInfoKHR</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>clCreateFromGLBuffer</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>clCreateFromGLTexture</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>clCreateFromGLRenderbuffer</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>clGetGLObjectInfo</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>clGetGLTextureInfo</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>clEnqueueAcquireGLObjects</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>clEnqueueReleaseGLObjects</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>cl_khr_mipmap_image</refentrytitle></citerefentry>
        </para>
    </refsect1>

<!-- ============================== COPYRIGHT -->
<!-- Content included from copyright.inc.xsl -->

    <refsect3 id="Copyright"><title></title>
        <imageobject>
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
        </imageobject>
        <para />
    </refsect3>

<!-- 4-Nov-2015, API ver 2.1 rev 19; Ext ver 2.1 rev 10 -->
</refentry>