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