sdk/2.1/docs/man/xhtml/preprocessorDirectives.html

<?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>Preprocessor Directives and Macros</title>
    <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
    <meta name="keywords" content="Preprocessor Directives and Macros" />
  </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="PreprocessorDirectivesandMacros"></a>
        <h1>Preprocessor Directives and Macros</h1>
        <p>
            Preprocessor Directives and Macros.
        </p>
      </div>
      <div class="refsect2">
        <a id="synopsis"></a>
        <h3>
        </h3>
        <div class="informaltable">
          <table class="informaltable" border="0">
            <colgroup>
              <col align="left" class="col1" />
            </colgroup>
            <tbody>
              <tr>
                <td align="left">
# <code class="function">pragma</code> <code class="varname">pp-tokens</code><sub>opt</sub> <span class="emphasis"><em>new-line</em></span>
                        </td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <div class="refsect1">
        <a id="description"></a>
        <h2>Description</h2>
        <p>
          The preprocessing directives defined by the C99 specification are supported.
        </p>
        <p>
          A <code class="function"># pragma</code> directive where the preprocessing token
          <code class="constant">OPENCL</code> (used instead of <code class="constant">STDC</code>) does not
          immediately follow <code class="function">pragma</code> in the directive (prior to any macro
          replacement) causes the implementation to behave in an implementation-defined manner. The
          behavior might cause translation to fail or cause the translator or the resulting
          program to behave in a non-conforming manner. Any such <code class="function">pragma</code>
          that is not recognized by the implementation is ignored. If the preprocessing token
          <code class="constant">OPENCL</code> does immediately follow <code class="function">pragma</code> in the
          directive (prior to any macro replacement), then no macro replacement is performed on
          the directive, and the directive shall have one of the following forms whose meanings
          are described elsewhere:
        </p>
        <p>
</p>
        <div class="literallayout">
          <p>
            <code class="constant">          #pragma OPENCL <a class="citerefentry" href="FP_CONTRACT.html"><span class="citerefentry"><span class="refentrytitle">FP_CONTRACT</span></span></a> <em class="replaceable"><code>on-off-switch</code></em><br />
               <em class="replaceable"><code>on-off-switch</code></em>: one of ON OFF DEFAULT<br />
          #pragma OPENCL <a class="citerefentry" href="EXTENSION.html"><span class="citerefentry"><span class="refentrytitle">EXTENSION</span></span></a> <code class="varname">extensionname : behavior</code><br />
          #pragma OPENCL <a class="citerefentry" href="EXTENSION.html"><span class="citerefentry"><span class="refentrytitle">EXTENSION</span></span></a> all : <code class="varname">behavior</code></code>
          </p>
        </div>
        <p>
        </p>
        <p>
          The following predefined macro names are available.
        </p>
        <div class="itemizedlist">
          <ul class="itemizedlist" style="list-style-type: disc; ">
            <li class="listitem" style="list-style-type: disc"><code class="code">__FILE__</code> The presumed name of the current 
                 source file (a character string literal).
            </li>
            <li class="listitem" style="list-style-type: disc"><code class="code">__LINE__</code> The presumed line number (within the current source file)
                 of the current source line (an integer constant).
            </li>
            <li class="listitem" style="list-style-type: disc"><code class="code">__OPENCL_VERSION__</code> substitutes an integer reflecting the version
                 number of the OpenCL supported by the OpenCL device. The version of OpenCL
                 described in this document will have <code class="code">__OPENCL_VERSION__</code> substitute
                 the integer 200.
            </li>
            <li class="listitem" style="list-style-type: disc"><code class="code">CL_VERSION_1_0</code> substitutes the integer 100 reflecting the OpenCL 1.0 version.
            </li>
            <li class="listitem" style="list-style-type: disc"><code class="code">CL_VERSION_1_1</code> substitutes the integer 110 reflecting the OpenCL 1.1 version.
            </li>
            <li class="listitem" style="list-style-type: disc"><code class="code">CL_VERSION_1_2</code> substitutes the integer 120 reflecting the OpenCL 1.2 version.
            </li>
            <li class="listitem" style="list-style-type: disc"><code class="code">CL_VERSION_2_0</code> substitutes the integer 200 reflecting the OpenCL 2.0 version.
            </li>
            <li class="listitem" style="list-style-type: disc"><code class="code">__OPENCL_C_VERSION__</code> substitutes an integer reflecting
                the OpenCL C version specified by the <code class="code">-cl-std</code> build option  to
                <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> or
                <a class="citerefentry" href="clCompileProgram.html"><span class="citerefentry"><span class="refentrytitle">clCompileProgram</span></span></a>. 
                If the <code class="code">-cl-std</code>
                build option is not specified, the highest OpenCL C 1.x 
                language version supported by each device is used 
                as the version of OpenCL C when compiling 
                the program for each device. The version of OpenCL C 
                described in this document will have 
                <code class="code">__OPENCL_C_VERSION__</code> substitute the integer 200 
                if <code class="code">–cl-std=CL2.0</code> is specified.
            </li>
            <li class="listitem" style="list-style-type: disc"><code class="code">__ENDIAN_LITTLE__</code> is used to determine if the OpenCL device is a
                little endian architecture or a big endian architecture (an integer constant
                of 1 if device is little endian and is undefined otherwise). Also refer to
                <code class="constant">CL_DEVICE_ENDIAN_LITTLE</code> specified in the table of OpenCL
                Device Queries for 
                <a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</span></span></a>.
            </li>
            <li class="listitem" style="list-style-type: disc"><code class="code">__kernel_exec(X, type<em class="replaceable"><code>n</code></em>)</code> (and
                <code class="code">kernel_exec(X, type<em class="replaceable"><code>n</code></em>))</code> is defined as
                follows:

                <p>
</p><div class="literallayout"><p>     <code class="code">__kernel __attribute__((work_group_size_hint(X, 1, 1)))</code> \<br />
              <code class="code">__attribute__((vec_type_hint(type<em class="replaceable"><code>n</code></em>)))</code></p></div><p>
                </p></li>
            <li class="listitem" style="list-style-type: disc"><code class="code">__IMAGE_SUPPORT__</code> is used to determine if the OpenCL device supports
                images. This is an integer constant of 1 if images are supported and is undefined
                otherwise. Also refer to <code class="constant">CL_DEVICE_IMAGE_SUPPORT</code>
                specified in the table of OpenCL Device Queries for
                <a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</span></span></a>.
            </li>
            <li class="listitem" style="list-style-type: disc"><code class="code">__FAST_RELAXED_MATH__</code> is used to determine if the
                cl-fast-relaxed-math optimization option is specified in build options given
                to  <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> or
                <a class="citerefentry" href="clCompileProgram.html"><span class="citerefentry"><span class="refentrytitle">clCompileProgram</span></span></a>. 
                This is an integer constant of 1 if the cl-fast-relaxed-math build option 
                is specified and is undefined otherwise.
             </li>
            <li class="listitem" style="list-style-type: disc">
                The <code class="code">NULL</code> macro expands to a null pointer 
                constant. An integer constant expression with the 
                value 0, or such an expression cast to type 
                <code class="code">void *</code> is called a null pointer constant.
            </li>
            <li class="listitem" style="list-style-type: disc">
                The macro names defined by the C99 specification but not currently supported
                by OpenCL are reserved for future use.
            </li>
            <li class="listitem" style="list-style-type: disc">
                The predefined identifier <code class="code">__func__</code> is available.
            </li>
          </ul>
        </div>
      </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.1-openclc.pdf#page=54" target="OpenCL Spec">OpenCL Specification</a>
        </p>
      </div>
      <div class="refsect1">
        <a id="seealso"></a>
        <h2>Also see</h2>
        <p>
            <a class="citerefentry" href="mathConstants.html"><span class="citerefentry"><span class="refentrytitle">Symbolic Math Constants</span></span></a>,
            <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a>,
            <a class="citerefentry" href="FP_CONTRACT.html"><span class="citerefentry"><span class="refentrytitle">FP_CONTRACT</span></span></a>,
            <a class="citerefentry" href="EXTENSION.html"><span class="citerefentry"><span class="refentrytitle">EXTENSION</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-2015 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>