<?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>get_image_channel_data_type</title>
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <meta name="keywords" content="get_image_channel_data_type" />
  </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="get_image_channel_data_type"></a>
        <h1>get_image_channel_data_type</h1>
        <p>
            Return the channel data type.
        </p>
      </div>
      <div class="refsynopsisdiv">
        <h2></h2>
        <div class="funcsynopsis">
          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
            <tr valign="bottom">
              <td>
                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
                    <a class="link" href="scalarDataTypes.html" target="_top">int</a>


                    <strong class="fsfunc">                   
                        get_image_channel_data_type
                    </strong>
                (</code>
                <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="otherDataTypes.html" target="_top">image2d_t</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">image</var><code>)</code></td>
              </td>
            </tr>
          </table>
        </div>
        <div class="funcsynopsis">
          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
            <tr valign="bottom">
              <td>
                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
                    <a class="link" href="scalarDataTypes.html" target="_top">int</a>


                    <strong class="fsfunc">                   
                        get_image_channel_data_type
                    </strong>
                (</code>
                <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="otherDataTypes.html" target="_top">image3d_t</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">image</var><code>)</code></td>
              </td>
            </tr>
          </table>
        </div>
      </div>
      <div class="refsect1">
        <a id="description"></a>
        <h2>Description</h2>
        <p>
            Return the channel data type. Valid values are:</p>
        <div class="literallayout">
          <p><br />
CLK_SNORM_INT8<br />
CLK_SNORM_INT16<br />
CLK_UNORM_INT8<br />
CLK_UNORM_INT16<br />
CLK_UNORM_SHORT_565<br />
CLK_UNORM_SHORT_555<br />
CLK_UNORM_SHORT_101010<br />
CLK_SIGNED_INT8<br />
CLK_SIGNED_INT16<br />
CLK_SIGNED_INT32<br />
CLK_UNSIGNED_INT8<br />
CLK_UNSIGNED_INT16<br />
CLK_UNSIGNED_INT32<br />
CLK_HALF_FLOAT<br />
CLK_FLOAT</p>
        </div>
        <p>
        </p>
        <p>
        The CLK_ prefixes in the list above correspond to the CL_ prefixes used to describe the image channel order and data type in the tables for <a class="citerefentry" href="cl_image_format.html"><span class="citerefentry"><span class="refentrytitle">cl_image_format</span></span></a>. For example, both CL_UNORM_INT8 and CLK_UNORM_INT8 refer to an image channel data type that is an unnormalized unsigned 8-bit integer.
        </p>
      </div>
      <div class="refsect1">
        <a id="notes"></a>
        <h2>Notes</h2>
        <p>
        The values returned by <code class="function">get_image_channel_data_type</code> as
shown above with the CLK_ prefixes correspond to the CL_ prefixes used to describe
the image channel order and data type in the table of supported names and values in 
<a class="citerefentry" href="clCreateSubBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateSubBuffer</span></span></a> and 
list of supported Image Channel Order Values for <a class="citerefentry" href="clCreateImage3D.html"><span class="citerefentry"><span class="refentrytitle">clCreateImage3D</span></span></a>.
For example, both
CL_UNORM_INT8 and CLK_UNORM_INT8 refer to an image channel data type that is an
unnormalized unsigned 8-bit integer.
        </p>
        <p>
      The following table describes the mapping of the number of channels of an image element to the appropriate components in the float4, int4 or unsigned int4 vector data type for the color values returned by <a class="citerefentry" href="readImage.html"><span class="citerefentry"><span class="refentrytitle">read_image{f|i|ui}</span></span></a> or supplied to <a class="citerefentry" href="writeImage.html"><span class="citerefentry"><span class="refentrytitle">write_image{f|i|ui}</span></span></a>. The unmapped components will be set to <code class="constant">0.0</code> for red, green and blue channels and will be set to <code class="constant">1.0</code> for the alpha channel.
        </p>
        <p>
        </p>
        <div class="informaltable">
          <table border="1">
            <colgroup>
              <col align="center" class="col1" />
              <col align="center" class="col2" />
            </colgroup>
            <thead>
              <tr>
                <th align="center">Channel Order</th>
                <th align="center">float4, int4 or unsigned int4 components of channel data</th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td align="center"><code class="constant">CL_R</code>, <code class="constant">CL_Rx</code></td>
                <td align="center">
                  <code class="constant">(r, 0.0, 0.0, 1.0)</code>
                </td>
              </tr>
              <tr>
                <td align="center">
                  <code class="constant">CL_A</code>
                </td>
                <td align="center">
                  <code class="constant">(0.0, 0.0, 0.0, a)</code>
                </td>
              </tr>
              <tr>
                <td align="center"><code class="constant">CL_RG</code>, <code class="constant">CL_RGx</code></td>
                <td align="center">
                  <code class="constant">(r, g, 0.0, 1.0)</code>
                </td>
              </tr>
              <tr>
                <td align="center">
                  <code class="constant">CL_RA</code>
                </td>
                <td align="center">
                  <code class="constant">(r, 0.0, 0.0, a)</code>
                </td>
              </tr>
              <tr>
                <td align="center"><code class="constant">CL_RGB</code>, <code class="constant">CL_RGBx</code></td>
                <td align="center">
                  <code class="constant">(r, g, b, 1.0)</code>
                </td>
              </tr>
              <tr>
                <td align="center">
                  <code class="constant">CL_RGBA, CL_BGRA, CL_ARGB</code>
                </td>
                <td align="center">
                  <code class="constant">(r, g, b, a)</code>
                </td>
              </tr>
              <tr>
                <td align="center">
                  <code class="constant">CL_INTENSITY</code>
                </td>
                <td align="center">
                  <code class="constant">(I, I, I, I)</code>
                </td>
              </tr>
              <tr>
                <td align="center">
                  <code class="constant">CL_LUMINANCE</code>
                </td>
                <td align="center">
                  <code class="constant">(L, L, L, 1.0)</code>
                </td>
              </tr>
            </tbody>
          </table>
        </div>
        <p>
        </p>
        <p>
        A kernel that uses a sampler with the CL_ADDRESS_CLAMP addressing mode with
multiple images may result in additional samplers being used internally by an implementation. If
the same sampler is used with multiple images called via 
<a class="citerefentry" href="read_imagef2d.html"><span class="citerefentry"><span class="refentrytitle">read_image{f | i | ui}</span></span></a>, then it is
possible that an implementation may need to allocate an additional sampler to handle the
different border color values that may be needed depending on the image formats being used.
These implementation allocated samplers will count against the maximum sampler values
supported by the device and given by CL_DEVICE_MAX_SAMPLERS. Enqueuing a kernel that
requires more samplers than the implementation can support will result in a
CL_OUT_OF_RESOURCES error being returned.
        </p>
      </div>
      <div class="refsect1">
        <a id="specification"></a>
        <h2>Specification</h2>
        <p>
            <img src="pdficon_small1.gif" />
                                                 
            <a href="http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf#page=234" target="OpenCL Spec">OpenCL Specification</a>
        </p>
      </div>
      <div class="refsect1">
        <a id="seealso"></a>
        <h2>Also see</h2>
        <p>
            <a class="citerefentry" href="imageFunctions.html"><span class="citerefentry"><span class="refentrytitle">Image Functions</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-2010 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>