sdk/2.0/docs/man/supportedImageFormats.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>Supported Image Formats</keyword>
        </keywordset>
    </refentryinfo>

    <refmeta>
        <refentrytitle>Supported Image Formats</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="supportedImageFormats">
        <refname>Supported Image Formats</refname>

        <refpurpose>
            Supported Image Formats
        </refpurpose>
    </refnamediv>

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

    <refsect1 id="description"><title>Description</title>
      <para>
            For 1D, 2D, 3D image objects, 1D and 2D image array objects, the mandated minimum list of 
            image formats that must be supported by all devices (that can be read from or written to by a 
            kernel but not both) that support images is described in the table below (Table 5.8.a):
      </para>

      <informaltable frame="all">
        <tgroup cols="3" align="left" colsep="1" rowsep="1">
          <colspec colname="col1" colnum="1" /> <colspec colname="col2" colnum="2" />
          <colspec colname="col3" colnum="3" />

          <thead>
            <row>
              <entry><literallayout>num_channels  </literallayout></entry>
              <entry><literallayout>channel_order  </literallayout></entry>
              <entry><literallayout>channel_data_type  </literallayout></entry>
            </row>
          </thead>

          <tbody>
            <row>
               <entry>1</entry>
               <entry><constant>CL_R</constant></entry>
               <entry>
<literallayout><constant>CL_UNORM_INT8</constant>
<constant>CL_UNORM_INT16</constant>

<constant>CL_SNORM_INT8</constant>
<constant>CL_SNORM_INT16</constant>

<constant>CL_SIGNED_INT8</constant>
<constant>CL_SIGNED_INT16</constant>
<constant>CL_SIGNED_INT32</constant>

<constant>CL_UNSIGNED_INT8</constant>
<constant>CL_UNSIGNED_INT16</constant>
<constant>CL_UNSIGNED_INT32</constant>

<constant>CL_HALF_FLOAT</constant>
<constant>CL_FLOAT</constant>
</literallayout>
               </entry>
             </row>

             <row>
               <entry>1</entry>
               <entry><constant>CL_DEPTH</constant></entry>
               <entry>
<literallayout><constant>CL_UNORM_INT16</constant>
<constant>CL_FLOAT</constant>
</literallayout>
               </entry>
             </row>

             <row>
               <entry>2</entry>
               <entry><constant>CL_RG</constant></entry>
               <entry>
<literallayout><constant>CL_UNORM_INT8</constant>
<constant>CL_UNORM_INT16</constant>

<constant>CL_SNORM_INT8</constant>
<constant>CL_SNORM_INT16</constant>

<constant>CL_SIGNED_INT8</constant>
<constant>CL_SIGNED_INT16</constant>
<constant>CL_SIGNED_INT32</constant>

<constant>CL_UNSIGNED_INT8</constant>
<constant>CL_UNSIGNED_INT16</constant>
<constant>CL_UNSIGNED_INT32</constant>

<constant>CL_HALF_FLOAT</constant>
<constant>CL_FLOAT</constant>
</literallayout>
               </entry>
             </row>

             <row>
               <entry>4</entry>
               <entry><constant>CL_RGBA</constant></entry>
               <entry>
<literallayout><constant>CL_UNORM_INT8</constant>
<constant>CL_UNORM_INT16</constant>

<constant>CL_SNORM_INT8</constant>
<constant>CL_SNORM_INT16</constant>

<constant>CL_SIGNED_INT8</constant>
<constant>CL_SIGNED_INT16</constant>
<constant>CL_SIGNED_INT32</constant>

<constant>CL_UNSIGNED_INT8</constant>
<constant>CL_UNSIGNED_INT16</constant>
<constant>CL_UNSIGNED_INT32</constant>

<constant>CL_HALF_FLOAT</constant>
<constant>CL_FLOAT</constant>
</literallayout>
               </entry>
             </row>

             <row>
               <entry>4</entry>
               <entry><constant>CL_BGRA</constant></entry>
               <entry>
<literallayout><constant>CL_UNORM_INT8</constant>
</literallayout>
               </entry>
             </row>

             <row>
               <entry>4</entry>
               <entry><constant>CL_sRGBA</constant></entry>
               <entry>
<literallayout><constant>CL_UNORM_INT8</constant>
</literallayout>
               </entry>
             </row>

          </tbody>
        </tgroup>
      </informaltable>

      <para>
          sRGB images can only be written to if the 
          <citerefentry><refentrytitle>cl_khr_srgb_image_writes</refentrytitle></citerefentry> 
          extension is supported.
      </para>

      <para>
        For 1D, 2D, 3D image objects, 1D and 2D image array objects, the mandated minimum list of 
        image formats that must be supported by all devices (that can be read from and written to by a 
        kernel) that support images is described in the table below (Table 5.8.b):
      </para>

      <informaltable frame="all">
        <tgroup cols="3" align="left" colsep="1" rowsep="1">
          <colspec colname="col1" colnum="1" /> <colspec colname="col2" colnum="2" />
          <colspec colname="col3" colnum="3" />

          <thead>
            <row>
              <entry><literallayout>num_channels  </literallayout></entry>
              <entry><literallayout>channel_order  </literallayout></entry>
              <entry><literallayout>channel_data_type  </literallayout></entry>
            </row>
          </thead>

          <tbody>
            <row>
               <entry>1</entry>
               <entry><constant>CL_R</constant></entry>
               <entry>
<literallayout><constant>CL_UNORM_INT8</constant>

<constant>CL_SIGNED_INT8</constant>
<constant>CL_SIGNED_INT16</constant>
<constant>CL_SIGNED_INT32</constant>

<constant>CL_UNSIGNED_INT8</constant>
<constant>CL_UNSIGNED_INT16</constant>
<constant>CL_UNSIGNED_INT32</constant>

<constant>CL_HALF_FLOAT</constant>
<constant>CL_FLOAT</constant>
</literallayout>
               </entry>
             </row>

            <row>
               <entry>4</entry>
               <entry><constant>CL_RGBA</constant></entry>
               <entry>
<literallayout><constant>CL_UNORM_INT8</constant>

<constant>CL_SIGNED_INT8</constant>
<constant>CL_SIGNED_INT16</constant>
<constant>CL_SIGNED_INT32</constant>

<constant>CL_UNSIGNED_INT8</constant>
<constant>CL_UNSIGNED_INT16</constant>
<constant>CL_UNSIGNED_INT32</constant>

<constant>CL_HALF_FLOAT</constant>
<constant>CL_FLOAT</constant>
</literallayout>
               </entry>
             </row>

          </tbody>
        </tgroup>
      </informaltable>

    </refsect1>

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

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

    <refsect1 id="seealso"><title>Also see</title>
        <para>
            <citerefentry><refentrytitle>EXTENSION</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>cl_image_format</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>cl_khr_3d_image_writes</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>cl_khr_srgb_image_writes</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>clGetSupportedImageFormats</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>

<!-- 22-Dec-2013, rev. 19 -->
</refentry>