File: unpackUnorm.xml

package info (click to toggle)
khronos-opengl-man4 1.0~svn33624-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,304 kB
  • sloc: xml: 93,066; makefile: 730; python: 627; javascript: 55; sh: 50; php: 4
file content (113 lines) | stat: -rw-r--r-- 5,754 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>

<!-- Converted by db4-upgrade version 1.1 -->

<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="unpackUnorm">
    <info>
        <copyright>
            <year>2011-2014</year>
            <holder>Khronos Group</holder>
        </copyright>
    </info>
    <refmeta>
        <refentrytitle>unpackUnorm</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>unpackUnorm2x16, unpackUnorm4x8, unpackSnorm4x8</refname>
        <refpurpose>unpack floating-point values from an unsigned integer</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>Declaration</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>vec2 <function>unpackUnorm2x16</function></funcdef>
                <paramdef>uint <parameter>p</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>vec2 <function>unpackSnorm2x16</function></funcdef>
                <paramdef>uint <parameter>p</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>vec4 <function>unpackUnorm4x8</function></funcdef>
                <paramdef>uint <parameter>p</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>vec4 <function>unpackSnorm4x8</function></funcdef>
                <paramdef>uint <parameter>p</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 xml:id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>p</parameter></term>
            <listitem>
                <para>
                    Specifies an unsigned integer containing packed floating-point values.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 xml:id="description"><title>Description</title>
        <para>
            <function>unpackUnorm2x16</function>, <function>unpackSnorm2x16</function>, <function>unpackUnorm4x8</function> and <function>unpackSnorm4x8</function> unpack
            single 32-bit unsigned integers, specified in the parameter <parameter>p</parameter> into a pair of 16-bit unsigned integers,
            four 8-bit unsigned integers or four 8-bit signed integers. Then, each component is converted to a normalized floating-point
            value to generate the returned two- or four-component vector.
        </para>
        <para>
            The conversion for unpacked fixed point value <emphasis>f</emphasis> to floating-point is performed as follows:
            <itemizedlist>
                <listitem><para><function>packUnorm2x16</function>: <code>f / 65535.0</code></para></listitem>
                <listitem><para><function>packSnorm2x16</function>: <code><function>clamp</function>(f / 32727.0, -1.0, 1.0)</code></para></listitem>
                <listitem><para><function>packUnorm4x8</function>: <code>f / 255.0</code></para></listitem>
                <listitem><para><function>packSnorm4x8</function>: <code><function>clamp</function>(f / 127.0, -1.0, 1.0)</code></para></listitem>
            </itemizedlist>
        </para>
        <para>
            The first component of the returned vector will be extracted from the least significant bits of the input;
            the last component will be extracted from the most significant bits.
        </para>
    </refsect1>
    <refsect1 xml:id="versions"><title>Version Support</title>
        <informaltable>
            <tgroup cols="13" align="left">
                <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="funchead.xml" xpointer="xpointer(/*/*)"/>
                <tbody>
                    <row>
                        <entry>unpackUnorm2x16</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='41']/*)"/>
                    </row>
                    <row>
                        <entry>unpackSnorm2x16</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='42']/*)"/>
                    </row>
                    <row>
                        <entry>unpackUnorm4x8</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='41']/*)"/>
                    </row>
                    <row>
                        <entry>unpackSnorm4x8</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='41']/*)"/>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect1>
    <refsect1 xml:id="seealso"><title>See Also</title>
        <para>
            <!-- FIX: link to packUnorm --> <function>packUnorm2x16</function>,
            <!-- FIX: link to packUnorm --> <function>packUnorm4x8</function>,
            <!-- FIX: link to packUnorm --> <function>packSnorm4x8</function>
        </para>
    </refsect1>
    <refsect1 xml:id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"/> 2011-2014 Khronos Group.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
        </para>
    </refsect1>
</refentry>