sdk/2.1/docs/man/cl_khr_mipmap_image.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">

<refentry>
    <refentryinfo>
        <keywordset>
            <keyword>cl_khr_mipmap_image</keyword>
        </keywordset>
    </refentryinfo>

    <refmeta>
        <refentrytitle>cl_khr_mipmap_image</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_mipmap_image">
        <refname>cl_khr_mipmap_image</refname>

        <refpurpose>
            Extension adds support for mipmaps.
        </refpurpose>
    </refnamediv>

    <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>
#pragma OPENCL EXTENSION cl_khr_mipmap_image : enable
                        </entry>
                    </row>
                    <row>
                        <entry>
#pragma OPENCL EXTENSION cl_khr_mipmap_image_writes : enable
                        </entry>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect2>

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

    <refsect1 id="description"><title>Description</title>
        <para>
            This extension adds support for mipmaps. This proposal is implemented 
            as two optional extensions. The <function>cl_khr_mipmap_image</function> 
            extension implements support to create a mipmapped image, enqueue commands 
            to read/write/copy/map a region of a mipmapped image and built-in 
            functions that can be used to read a mip-mapped image in an OpenCL C 
            program. The <function>cl_khr_mipmap_image_writes</function> extension 
            adds built-in functions that can be used to write a mip-mapped image in 
            an OpenCL C program. If the <function>cl_khr_mipmap_image_writes</function> 
            extension is supported by the OpenCL device, the 
            <function>cl_khr_mipmap_image</function> extension must also be supported.
        </para>

        <para>
            This extension enables the following functions:
        </para>

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

        <para>
            This extension enables changes to the following:
        </para>

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

                    <row>
                        <entry><citerefentry><refentrytitle>clEnqueueReadImage</refentrytitle></citerefentry></entry>
                    </row>

                    <row>
                        <entry><citerefentry><refentrytitle>clEnqueueWriteImage</refentrytitle></citerefentry></entry>
                    </row>

                    <row>
                        <entry><citerefentry><refentrytitle>clEnqueueMapImage</refentrytitle></citerefentry></entry>
                    </row>

                    <row>
                        <entry><citerefentry><refentrytitle>clEnqueueCopyImage</refentrytitle></citerefentry></entry>
                    </row>

                    <row>
                        <entry><citerefentry><refentrytitle>clEnqueueCopyImageToBuffer</refentrytitle></citerefentry></entry>
                    </row>

                    <row>
                        <entry><citerefentry><refentrytitle>clEnqueueCopyBufferToImage</refentrytitle></citerefentry></entry>
                    </row>

                    <row>
                        <entry><citerefentry><refentrytitle>clCreateSamplerWithProperties</refentrytitle></citerefentry></entry>
                    </row>

                    <row>
                        <entry><citerefentry><refentrytitle>imageFunctions</refentrytitle></citerefentry></entry>
                    </row>

                    <row>
                        <entry><citerefentry><refentrytitle>cl_khr_gl_sharing</refentrytitle></citerefentry></entry>
                    </row>

                    <row>
                        <entry><citerefentry><refentrytitle>clCreateFromGLTexture</refentrytitle></citerefentry></entry>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect1>

<!-- ================================ 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_mipmap_image">OpenCL Specification</olink>
        </para>
    </refsect1>

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

    <refsect1 id="seealso"><title>Also see</title>
        <para>
            <citerefentry><refentrytitle>EXTENSION</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>get_image_num_mip_levels</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, Ext rev. 10 -->
</refentry>