upstream-man-pages/manglsl/packHalf2x16.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="packHalf2x16">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12             <refentrytitle>packHalf2x16</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>packHalf2x16</refname>
  17         <refpurpose>convert two 32-bit floating-point quantities to 16-bit quantities and pack them into a single 32-bit integer</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>uint <function>packHalf2x16</function></funcdef>
  23                 <paramdef>vec2 <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 vector of two 32-bit floating point values that are to be converted to 16-bit representation and packed into the result.
  34                 </para>
  35             </listitem>
  36         </varlistentry>
  37         </variablelist>
  38     </refsect1>
  39     <refsect1 id="description"><title>Description</title>
  40         <para>
  41             <function>packHalf2x16</function> returns an unsigned integer obtained by converting the
  42             components of a two-component floating-point vector to
  43             the 16-bit floating-point representation found in the
  44             OpenGL Specification, and then packing these two 16-bit integers into a 32-bit unsigned integer.
  45             The first vector component specifies the 16 least-significant bits of the result; the second component
  46             specifies the 16 most-significant bits.
  47         </para>
  48     </refsect1>
  49     <refsect1 id="versions"><title>Version Support</title>
  50         <informaltable frame="topbot">
  51             #VARTABLECOLS#
  52                 <thead>
  53                     #FUNCTABLEHEADER#
  54                     <row>
  55                         <entry>packHalf2x16</entry>#newin42#
  56                     </row>
  57                 </thead>
  58             </tgroup>
  59         </informaltable>
  60     </refsect1>
  61     <refsect1 id="seealso"><title>See Also</title>
  62         <para>
  63             <citerefentry><refentrytitle>packDouble2x32</refentrytitle></citerefentry>,
  64             <citerefentry><refentrytitle>unpackDouble2x32</refentrytitle></citerefentry>,
  65             <citerefentry><refentrytitle>unpackHalf2x16</refentrytitle></citerefentry>
  66         </para>
  67     </refsect1>
  68     <refsect1 id="Copyright"><title>Copyright</title>
  69         <para>
  70             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  71             This material may be distributed subject to the terms and conditions set forth in
  72             the Open Publication License, v 1.0, 8 June 1999.
  73             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  74         </para>
  75     </refsect1>
  76 </refentry>