rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / manglsl / xhtml / packUnorm2x16.xml
CommitLineData
7faf1d71
AW
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
3<!-- saved from url=(0013)about:internet -->
4<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>packUnorm - OpenGL Shading Language (GLSL)</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="packUnorm"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>packUnorm — pack floating-point values into an unsigned integer</p></div><div class="refsynopsisdiv"><h2>Declaration</h2><div class="funcsynopsis"><p><code class="funcdef">uint <b class="fsfunc">packUnorm2x16</b>(</code>vec2 <var class="pdparam">v</var><code>)</code>;</p><p><code class="funcdef">uint <b class="fsfunc">packSnorm2x16</b>(</code>vec2 <var class="pdparam">v</var><code>)</code>;</p><p><code class="funcdef">uint <b class="fsfunc">packUnorm4x8</b>(</code>vec4 <var class="pdparam">v</var><code>)</code>;</p><p><code class="funcdef">uint <b class="fsfunc">packSnorm4x8</b>(</code>vec4 <var class="pdparam">v</var><code>)</code>;</p></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>v</code></em></span></dt><dd><p>
5 Specifies a vector of values to be packed into an unsigned integer.
6 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
7 <code class="function">packUnorm2x16</code>, <code class="function">packSnorm2x16</code>, <code class="function">packUnorm4x8</code> and <code class="function">packSnorm4x8</code> convert
8 each component of the normalized floating-ponit value <em class="parameter"><code>v</code></em> into 8- or 16-bit integer
9 values and then packs the results into a 32-bit unsigned intgeter.
10 </p><p>
11 The conversion for component <em class="parameter"><code>c</code></em> of <em class="parameter"><code>v</code></em> to fixed-point is
12 performed as follows:
13 </p><div class="itemizedlist"><ul type="disc"><li><code class="function">packUnorm2x16</code>: <code class="code"><a href="round.xml"><span class="citerefentry"><span class="refentrytitle">round</span></span></a>(<a href="clamp.xml"><span class="citerefentry"><span class="refentrytitle">clamp</span></span></a>(<em class="parameter"><code>c</code></em>, 0.0, 1.0) * 65535.0)</code></li><li><code class="function">packSnorm2x16</code>: <code class="code"><a href="round.xml"><span class="citerefentry"><span class="refentrytitle">round</span></span></a>(<a href="clamp.xml"><span class="citerefentry"><span class="refentrytitle">clamp</span></span></a>(<em class="parameter"><code>c</code></em>, -1.0, 1.0) * 32767.0)</code></li><li><code class="function">packUnorm4x8</code>: <code class="code"><a href="round.xml"><span class="citerefentry"><span class="refentrytitle">round</span></span></a>(<a href="clamp.xml"><span class="citerefentry"><span class="refentrytitle">clamp</span></span></a>(<em class="parameter"><code>c</code></em>, 0.0, 1.0) * 255.0)</code></li><li><code class="function">packSnorm4x8</code>: <code class="code"><a href="round.xml"><span class="citerefentry"><span class="refentrytitle">round</span></span></a>(<a href="clamp.xml"><span class="citerefentry"><span class="refentrytitle">clamp</span></span></a>(<em class="parameter"><code>c</code></em>, -1.0, 1.0) * 127.0)</code></li></ul></div><p>
14 </p><p>
15 The first component of the vector will be written to the least significant bits of the output;
16 the last component will be written to the most significant bits.
17 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="versions"></a><h2>Version Support</h2><div class="informaltable"><table border="1"><colgroup><col align="left" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /></colgroup><thead><tr><th align="left"><span class="bold"><strong>Function</strong></span></th><th align="left"><span class="bold"><strong>Version 1.10</strong></span></th><th align="left"><span class="bold"><strong>Version 1.20</strong></span></th><th align="left"><span class="bold"><strong>Version 1.30</strong></span></th><th align="left"><span class="bold"><strong>Version 1.40</strong></span></th><th align="left"><span class="bold"><strong>Version 1.50</strong></span></th><th align="left"><span class="bold"><strong>Version 3.30</strong></span></th><th align="left"><span class="bold"><strong>Version 4.00</strong></span></th><th align="left"><span class="bold"><strong>Version 4.10</strong></span></th><th align="left"><span class="bold"><strong>Version 4.20</strong></span></th><th align="center"><span class="bold"><strong>Version 4.30</strong></span></th></tr><tr><th align="left">packUnorm2x16</th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th></tr><tr><th align="left">packSnorm2x16</th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th></tr><tr><th align="left">packUnorm4x8</th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th></tr><tr><th align="left">packSnorm4x8</th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th></tr></thead></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
18 <a href="unpackUnorm2x16.xml"><span class="citerefentry"><span class="refentrytitle">unpackUnorm2x16</span></span></a>,
19 <a href="unpackSnorm2x16.xml"><span class="citerefentry"><span class="refentrytitle">unpackSnorm2x16</span></span></a>,
20 <a href="unpackUnorm4x8.xml"><span class="citerefentry"><span class="refentrytitle">unpackUnorm4x8</span></span></a>,
21 <a href="unpackSnorm4x8.xml"><span class="citerefentry"><span class="refentrytitle">unpackSnorm4x8</span></span></a>
22 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
23 Copyright <span class="trademark"></span>© 2011 Khronos Group.
24 This material may be distributed subject to the terms and conditions set forth in
25 the Open Publication License, v 1.0, 8 June 1999.
26 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
27 </p></div></div></body></html>