upstream-man-pages/manglsl/bitfieldReverse.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="bitfieldReverse">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>bitfieldReverse</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>bitfieldReverse</refname>
  17         <refpurpose>reverse the order of bits in an integer</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>genIType <function>bitfieldReverse</function></funcdef>
  23                 <paramdef>genIType <parameter>value</parameter></paramdef>
  24             </funcprototype>            <funcprototype>
  25                 <funcdef>genUType <function>bitfieldReverse</function></funcdef>
  26                 <paramdef>genUType <parameter>value</parameter></paramdef>
  27             </funcprototype>
  28         </funcsynopsis>
  29     </refsynopsisdiv>
  30     <refsect1 id="parameters"><title>Parameters</title>
  31         <variablelist>
  32         <varlistentry>
  33             <term><parameter>value</parameter></term>
  34             <listitem>
  35                 <para>
  36                     Specifies the value whose bits to reverse.
  37                 </para>
  38             </listitem>
  39         </varlistentry>
  40         </variablelist>
  41     </refsect1>
  42     <refsect1 id="description"><title>Description</title>
  43         <para>
  44             <function>bitfieldReverse</function> returns the reversal of the bits of value. The bit
  45             numbered <emphasis>n</emphasis> will be taken from bit (<emphasis>bits</emphasis> - 1) - <emphasis>n</emphasis>
  46             of <parameter>value</parameter>, where <emphasis>bits</emphasis> is the total number of bits used to represent
  47             <parameter>value</parameter>.
  48         </para>
  49     </refsect1>
  50     <refsect1 id="versions"><title>Version Support</title>
  51         <informaltable frame="topbot">
  52             #VARTABLECOLS#
  53                 <thead>
  54                     #FUNCTABLEHEADER#
  55                     <row>
  56                         <entry>bitfieldReverse</entry>#newin40#
  57                     </row>
  58                 </thead>
  59             </tgroup>
  60         </informaltable>
  61     </refsect1>
  62     <refsect1 id="seealso"><title>See Also</title>
  63         <para>
  64             <citerefentry><refentrytitle>bitfieldExtract</refentrytitle></citerefentry>,
  65             <citerefentry><refentrytitle>bitfieldInsert</refentrytitle></citerefentry>,
  66             <citerefentry><refentrytitle>bitCount</refentrytitle></citerefentry>
  67         </para>
  68     </refsect1>
  69     <refsect1 id="Copyright"><title>Copyright</title>
  70         <para>
  71             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  72             This material may be distributed subject to the terms and conditions set forth in
  73             the Open Publication License, v 1.0, 8 June 1999.
  74             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  75         </para>
  76     </refsect1>
  77 </refentry>