sdk/1.0/docs/man/reservedDataTypes.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>                            
                Reserved Data Types
            </keyword>
        </keywordset>
    </refentryinfo>

    <refmeta>                                    
        <refentrytitle>Reserved Data Types</refentrytitle>

        <refmiscinfo>
            <copyright>
                <year>2007-2009</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>2</manvolnum>
    </refmeta>

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

    <refnamediv id="Reserved Data Types">             
        <refname>Reserved Data Types</refname>

        <refpurpose>
            Built-in reserved Data Types.
        </refpurpose>
    </refnamediv>



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

    <refsect1 id="description"><title>Description</title>
        <para>
The data type names described in the table below
are reserved and cannot be used by applications as
user-defined type names. The vector data type
names defined in
<citerefentry href="vectorDataTypes.html"><refentrytitle>Vector Data Types</refentrytitle></citerefentry>,
but where <varname>n</varname> is any
value other than 2, 4, 8 and 16, are also reserved.
        </para>
<para>
        <informaltable frame="all">
            <tgroup cols="2" align="left" colsep="1" rowsep="1">
                <colspec colname="col1" colnum="1" />
                <colspec colname="col2" colnum="2" />

                <thead>
                    <row>
                        <entry>Type</entry>
                        <entry>Description</entry>
                    </row>
                </thead>

                <tbody>

                    <row>
                        <entry>
<type>bool<replaceable>n</replaceable></type>
                        </entry>

                        <entry>
A boolean vector.
                        </entry>
                    </row>

                    <row>
                        <entry>
<type>double</type>, <type>double<replaceable>n</replaceable></type>
                        </entry>

                        <entry>
A double precision floating-point number, and double precision vector.
                        </entry>
                    </row>

                    <row>
                        <entry>
<type>half<replaceable>n</replaceable></type>
                        </entry>

                        <entry>
A 16-bit float vector.
                        </entry>
                    </row>

                    <row>
                        <entry>
<type>quad</type>, <type>quad<replaceable>n</replaceable></type>
                        </entry>

                        <entry>
A 128-bit floating-point number and vectors.
                        </entry>
                    </row>

                    <row>
                        <entry>
<literallayout><type>complex half</type>,
<type>complex half<replaceable>n</replaceable></type>,
<type>imaginary half</type>,
<type>imaginary half<replaceable>n</replaceable></type></literallayout>
                        </entry>

                        <entry>
A complex 16-bit floating-point number, and complex and imaginary
16-bit floating-point vectors.
                        </entry>
                    </row>

                    <row>
                        <entry>
<literallayout><type>complex float</type>,
<type>complex float<replaceable>n</replaceable></type>,
<type>imaginary float</type>,
<type>imaginary float<replaceable>n</replaceable></type></literallayout>
                        </entry>

                        <entry>
A complex single precision floating-point
number, and complex and imaginary single
precision floating-point vectors.
                        </entry>
                    </row>

                    <row>
                        <entry>
<literallayout><type>complex double</type>,
<type>complex double<replaceable>n</replaceable></type>,
<type>imaginary double</type>,
<type>imaginary double<replaceable>n</replaceable></type></literallayout>
                        </entry>

                        <entry>
A complex double precision floating-point
number, and complex and imaginary double
precision floating-point vectors.
                        </entry>
                    </row>

                    <row>
                        <entry>
<literallayout><type>complex quad</type>,
<type>complex quad<replaceable>n</replaceable></type>,
<type>imaginary quad</type>,
<type>imaginary quad<replaceable>n</replaceable></type></literallayout>
                        </entry>

                        <entry>
A complex 128-bit floating-point number, and
complex and imaginary 128-bit floating-point
vectors.
                        </entry>
                    </row>

                    <row>
                        <entry>
<type>float<replaceable>n</replaceable></type>x<emphasis>m</emphasis>
                        </entry>

                        <entry>
An <emphasis>n</emphasis> x <emphasis>m</emphasis> matrix of single precision
floating-point values stored in column-major order.
                        </entry>
                    </row>

                    <row>
                        <entry>
<type>double<replaceable>n</replaceable></type>x<emphasis>m</emphasis>
                        </entry>

                        <entry>
An <emphasis>n</emphasis> x <emphasis>m</emphasis> matrix of double precision
floating-point values stored in column-major order.
                        </entry>
                    </row>

                    <row>
                        <entry>
<literallayout><type>long double</type>,
<type>long double<replaceable>n</replaceable></type></literallayout>
                        </entry>

                        <entry>
A floating-point scalar and vector type with at
long doublen least as much precision and range as a double
and no more precision and range than a quad.
                        </entry>
                    </row>

                    <row>
                        <entry>
<type>long long</type>,
<type>long long<replaceable>n</replaceable></type>
                        </entry>

                        <entry>
A 128-bit signed integer scalar and vector.
                        </entry>
                    </row>

                    <row>
                        <entry>
<type>unsigned long long</type>,
<type>ulong long</type>, 
<type>ulong long<replaceable>n</replaceable></type>
                        </entry>

                        <entry>
A 128-bit unsigned integer scalar and vector.
                        </entry>
                    </row>

                </tbody>
            </tgroup>
        </informaltable>
</para>
<para>
<!-- sorry, I still haven't learned what anchor text to use for the links below - drm -->
The C99 derived types (arrays, structs, union, function, and pointers), constructed from the
built-in data types described in
<citerefentry href="scalarDataTypes"><refentrytitle>Scalar Data Types</refentrytitle></citerefentry>,
<citerefentry href="vectorDataTypes"><refentrytitle>Vector Data Types</refentrytitle></citerefentry>, and 
<citerefentry href="otherDataTypes"><refentrytitle>Other Data Types</refentrytitle></citerefentry> 
are also supported.
</para>

<para>
The type qualifiers <constant>const</constant>,
<constant>restrict</constant>, and <constant>volatile</constant> as
defined by the C99 specification are
supported. These qualifiers cannot be
used with <type><citerefentry href="otherDataTypes"><refentrytitle>image2d_t</refentrytitle></citerefentry></type> 
and <type><citerefentry href="otherDataTypes"><refentrytitle>image3d_t</refentrytitle></citerefentry></type>
type. Types other than pointer types
shall not use the <constant>restrict</constant> qualifier.
</para>

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


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

    <refsect1 id="seealso"><title>Also see</title>
        <para>
            <citerefentry href="macroLimits"><refentrytitle>Macros and Limits</refentrytitle></citerefentry>, 
            <citerefentry href="scalarDataTypes"><refentrytitle>Scalar Data Types</refentrytitle></citerefentry>,
			<citerefentry href="vectorDataTypes"><refentrytitle>Vector Data Types</refentrytitle></citerefentry>,  
			<citerefentry href="otherDataTypes"><refentrytitle>Other Data Types</refentrytitle></citerefentry>,  
			<citerefentry href="abstractDataTypes"><refentrytitle>Abstract Data Types</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>

</refentry>