HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 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="bitfieldExtract">\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>bitfieldExtract</refentrytitle>\r | |
| 13 | <manvolnum>3G</manvolnum>\r | |
| 14 | </refmeta>\r | |
| 15 | <refnamediv>\r | |
| 16 | <refname>bitfieldExtract</refname>\r | |
| 17 | <refpurpose>extract a range of bits from an integer</refpurpose>\r | |
| 18 | </refnamediv>\r | |
| 19 | <refsynopsisdiv><title>Declaration</title>\r | |
| 20 | <funcsynopsis>\r | |
| 21 | <funcprototype>\r | |
| 22 | <funcdef>genIType <function>bitfieldExtract</function></funcdef>\r | |
| 23 | <paramdef>genIType <parameter>value</parameter></paramdef>\r | |
| 24 | <paramdef>int <parameter>offset</parameter></paramdef>\r | |
| 25 | <paramdef>int <parameter>bits</parameter></paramdef>\r | |
| 26 | </funcprototype> <funcprototype>\r | |
| 27 | <funcdef>genUType <function>bitfieldExtract</function></funcdef>\r | |
| 28 | <paramdef>genUType <parameter>value</parameter></paramdef>\r | |
| 29 | <paramdef>int <parameter>offset</parameter></paramdef>\r | |
| 30 | <paramdef>int <parameter>bits</parameter></paramdef>\r | |
| 31 | </funcprototype>\r | |
| 32 | </funcsynopsis>\r | |
| 33 | </refsynopsisdiv>\r | |
| 34 | <refsect1 id="parameters"><title>Parameters</title>\r | |
| 35 | <variablelist>\r | |
| 36 | <varlistentry>\r | |
| 37 | <term><parameter>value</parameter></term>\r | |
| 38 | <listitem>\r | |
| 39 | <para>\r | |
| 40 | Specifies the integer from which to extract bits.\r | |
| 41 | </para>\r | |
| 42 | </listitem>\r | |
| 43 | </varlistentry>\r | |
| 44 | <varlistentry>\r | |
| 45 | <term><parameter>offset</parameter></term>\r | |
| 46 | <listitem>\r | |
| 47 | <para>\r | |
| 48 | Specifies the index of the first bit to extract.\r | |
| 49 | </para>\r | |
| 50 | </listitem>\r | |
| 51 | </varlistentry>\r | |
| 52 | <varlistentry>\r | |
| 53 | <term><parameter>bits</parameter></term>\r | |
| 54 | <listitem>\r | |
| 55 | <para>\r | |
| 56 | Specifies the number of bits to extract.\r | |
| 57 | </para>\r | |
| 58 | </listitem>\r | |
| 59 | </varlistentry>\r | |
| 60 | </variablelist>\r | |
| 61 | </refsect1>\r | |
| 62 | <refsect1 id="description"><title>Description</title>\r | |
| 63 | <para>\r | |
| 64 | <function>bitfieldExtract</function> extracts a subset of the bits of <parameter>value</parameter> and returns\r | |
| 65 | it in the least significant bits of the result. The range of bits extracted is [<parameter>offset</parameter>, <parameter>offset</parameter> + <parameter>bits</parameter> + 1].\r | |
| 66 | </para>\r | |
| 67 | <para>\r | |
| 68 | For unsigned data types, the most significant bits of the result will be set to zero. For signed data types, the most significant bits will be set to the value of\r | |
| 69 | bit <parameter>offset</parameter> + <parameter>base</parameter> - 1 (i.e., it is <emphasis>sign extended</emphasis> to the width of the return type).\r | |
| 70 | <para>\r | |
| 71 | </para>\r | |
| 72 | If <parameter>bits</parameter> is zero, the result will be zero. The result will be undefined if <parameter>offset</parameter> or <parameter>bits</parameter> is negative,\r | |
| 73 | or if the sum of <parameter>offset</parameter> and <parameter>bits</parameter> is greater than the number of bits used to store the operand.\r | |
| 74 | </para>\r | |
| 75 | </refsect1>\r | |
| 76 | <refsect1 id="versions"><title>Version Support</title>\r | |
| 77 | <informaltable frame="topbot">\r | |
| 78 | #VARTABLECOLS#\r | |
| 79 | <thead>\r | |
| 80 | #FUNCTABLEHEADER#\r | |
| 81 | <row>\r | |
| 82 | <entry>bitfieldInsert</entry>#newin40#\r | |
| 83 | </row>\r | |
| 84 | </thead>\r | |
| 85 | </tgroup>\r | |
| 86 | </informaltable>\r | |
| 87 | </refsect1>\r | |
| 88 | <refsect1 id="seealso"><title>See Also</title>\r | |
| 89 | <para>\r | |
| 90 | <citerefentry><refentrytitle>bitfieldExtract</refentrytitle></citerefentry>\r | |
| 91 | </para>\r | |
| 92 | </refsect1>\r | |
| 93 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
| 94 | <para>\r | |
| 95 | Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r | |
| 96 | This material may be distributed subject to the terms and conditions set forth in \r | |
| 97 | the Open Publication License, v 1.0, 8 June 1999.\r | |
| 98 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
| 99 | </para>\r | |
| 100 | </refsect1>\r | |
| 101 | </refentry>\r |