rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / manglsl / unpackHalf2x16.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="unpackHalf2x16">\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>unpackHalf2x16</refentrytitle>\r
13 <manvolnum>3G</manvolnum>\r
14 </refmeta>\r
15 <refnamediv>\r
16 <refname>unpackHalf2x16</refname>\r
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>\r
18 </refnamediv>\r
19 <refsynopsisdiv><title>Declaration</title>\r
20 <funcsynopsis>\r
21 <funcprototype>\r
22 <funcdef>vec2 <function>unpackHalf2x16</function></funcdef>\r
23 <paramdef>uint <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 single 32-bit unsigned integer values that contains two 16-bit floating point values to be unpacked.\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>unpackHalf2x16</function> returns a two-component floating-point vector with\r
42 components obtained by unpacking a 32-bit unsigned\r
43 integer into a pair of 16-bit values, interpreting those\r
44 values as 16-bit floating-point numbers according to the\r
45 OpenGL Specification, and converting them to 32-bit\r
46 floating-point values.\r
47 The first component of the vector is obtained from the\r
48 16 least-significant bits of v; the second component is\r
49 obtained from the 16 most-significant bits of v.\r
50 </para>\r
51 </refsect1>\r
52 <refsect1 id="versions"><title>Version Support</title>\r
53 <informaltable frame="topbot">\r
54 #VARTABLECOLS#\r
55 <thead>\r
56 #FUNCTABLEHEADER#\r
57 <row>\r
58 <entry>unpackHalf2x16</entry>#newin42#\r
59 </row>\r
60 </thead>\r
61 </tgroup>\r
62 </informaltable>\r
63 </refsect1>\r
64 <refsect1 id="seealso"><title>See Also</title>\r
65 <para>\r
66 <citerefentry><refentrytitle>packDouble2x32</refentrytitle></citerefentry>,\r
67 <citerefentry><refentrytitle>unpackDouble2x32</refentrytitle></citerefentry>,\r
68 <citerefentry><refentrytitle>packHalf2x16</refentrytitle></citerefentry>\r
69 </para>\r
70 </refsect1>\r
71 <refsect1 id="Copyright"><title>Copyright</title>\r
72 <para>\r
73 Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
74 This material may be distributed subject to the terms and conditions set forth in \r
75 the Open Publication License, v 1.0, 8 June 1999.\r
76 <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
77 </para>\r
78 </refsect1>\r
79</refentry>\r