upstream-doc/manglsl/unpackHalf2x16.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="unpackHalf2x16">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12             <refentrytitle>unpackHalf2x16</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>unpackHalf2x16</refname>
  17         <refpurpose>convert two 16-bit floating-point values packed into a single 32-bit integer into a vector of two 32-bit floating-point quantities</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>vec2 <function>unpackHalf2x16</function></funcdef>
  23                 <paramdef>uint <parameter>v</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="parameters"><title>Parameters</title>
  28         <variablelist>
  29         <varlistentry>
  30             <term><parameter>v</parameter></term>
  31             <listitem>
  32                 <para>
  33                     Specify a single 32-bit unsigned integer values that contains two 16-bit floating point values to be unpacked.
  34                 </para>
  35             </listitem>
  36         </varlistentry>
  37         </variablelist>
  38     </refsect1>
  39     <refsect1 id="description"><title>Description</title>
  40         <para>
  41             <function>unpackHalf2x16</function> returns  a two-component floating-point vector with
  42             components obtained by unpacking a 32-bit unsigned
  43             integer into a pair of 16-bit values, interpreting those
  44             values as 16-bit floating-point numbers according to the
  45             OpenGL Specification, and converting them to 32-bit
  46             floating-point values.
  47             The first component of the vector is obtained from the
  48             16 least-significant bits of v; the second component is
  49             obtained from the 16 most-significant bits of v.
  50         </para>
  51     </refsect1>
  52     <refsect1 id="versions"><title>Version Support</title>
  53         <informaltable frame="topbot">
  54             #VARTABLECOLS#
  55                 <thead>
  56                     #FUNCTABLEHEADER#
  57                     <row>
  58                         <entry>unpackHalf2x16</entry>#newin42#
  59                     </row>
  60                 </thead>
  61             </tgroup>
  62         </informaltable>
  63     </refsect1>
  64     <refsect1 id="seealso"><title>See Also</title>
  65         <para>
  66             <citerefentry><refentrytitle>packDouble2x32</refentrytitle></citerefentry>,
  67             <citerefentry><refentrytitle>unpackDouble2x32</refentrytitle></citerefentry>,
  68             <citerefentry><refentrytitle>packHalf2x16</refentrytitle></citerefentry>
  69         </para>
  70     </refsect1>
  71     <refsect1 id="Copyright"><title>Copyright</title>
  72         <para>
  73             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  74             This material may be distributed subject to the terms and conditions set forth in
  75             the Open Publication License, v 1.0, 8 June 1999.
  76             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  77         </para>
  78     </refsect1>
  79 </refentry>