upstream-doc/man2/glGetPolygonStipple.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="glGetPolygonStipple">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glGetPolygonStipple</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glGetPolygonStipple</refname>
  17         <refpurpose>return the polygon stipple pattern</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glGetPolygonStipple</function></funcdef>
  23                 <paramdef>GLubyte * <parameter>pattern</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <!-- eqn: ignoring delim $$ -->
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>pattern</parameter></term>
  32             <listitem>
  33                 <para>
  34                     Returns the stipple pattern. The initial value is all 1's.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         </variablelist>
  39     </refsect1>
  40     <refsect1 id="description"><title>Description</title>
  41         <para>
  42             <function>glGetPolygonStipple</function> returns to <parameter>pattern</parameter> a
  43             <inlineequation><mml:math>
  44                 <!-- eqn: 32  times  32:-->
  45                 <mml:mrow>
  46                     <mml:mn>32</mml:mn>
  47                     <mml:mo>&times;</mml:mo>
  48                     <mml:mn>32</mml:mn>
  49                 </mml:mrow>
  50             </mml:math></inlineequation>
  51             polygon stipple pattern.
  52             The pattern is packed into memory as if <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry>
  53             with both <emphasis>height</emphasis> and <emphasis>width</emphasis> of 32,
  54             <emphasis>type</emphasis> of <constant>GL_BITMAP</constant>,
  55             and <emphasis>format</emphasis> of <constant>GL_COLOR_INDEX</constant> were called,
  56             and the stipple pattern were stored in an internal
  57             <inlineequation><mml:math>
  58                 <!-- eqn: 32  times  32:-->
  59                 <mml:mrow>
  60                     <mml:mn>32</mml:mn>
  61                     <mml:mo>&times;</mml:mo>
  62                     <mml:mn>32</mml:mn>
  63                 </mml:mrow>
  64             </mml:math></inlineequation>
  65             color
  66             index buffer.
  67             Unlike <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry>,
  68             however,
  69             pixel transfer operations
  70             (shift, offset, pixel map)
  71             are not applied to the returned stipple image.
  72         </para>
  73         <para>
  74             If a non-zero named buffer object is bound to the <constant>GL_PIXEL_PACK_BUFFER</constant> target
  75             (see <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>) while a polygon stipple pattern is
  76             requested, <parameter>pattern</parameter> is treated as a byte offset into the buffer object's data store.
  77         </para>
  78     </refsect1>
  79     <refsect1 id="notes"><title>Notes</title>
  80         <para>
  81             If an error is generated,
  82             no change is made to the contents of <parameter>pattern</parameter>.
  83         </para>
  84     </refsect1>
  85     <refsect1 id="errors"><title>Errors</title>
  86         <para>
  87             <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
  88             <constant>GL_PIXEL_PACK_BUFFER</constant> target and the buffer object's data store is currently mapped.
  89         </para>
  90         <para>
  91             <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
  92             <constant>GL_PIXEL_PACK_BUFFER</constant> target and the data would be packed to the buffer
  93             object such that the memory writes required would exceed the data store size.
  94         </para>
  95         <para>
  96             <constant>GL_INVALID_OPERATION</constant> is generated if <function>glGetPolygonStipple</function>
  97             is executed between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>
  98             and the corresponding execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
  99         </para>
 100     </refsect1>
 101     <refsect1 id="associatedgets"><title>Associated Gets</title>
 102         <para>
 103             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_PIXEL_PACK_BUFFER_BINDING</constant>
 104         </para>
 105     </refsect1>
 106     <refsect1 id="seealso"><title>See Also</title>
 107         <para>
 108             <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>,
 109             <citerefentry><refentrytitle>glPixelTransfer</refentrytitle></citerefentry>,
 110             <citerefentry><refentrytitle>glPolygonStipple</refentrytitle></citerefentry>,
 111             <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry>
 112         </para>
 113     </refsect1>
 114     <refsect1 id="Copyright"><title>Copyright</title>
 115         <para>
 116             Copyright <trademark class="copyright"></trademark> 1991-2006
 117             Silicon Graphics, Inc. This document is licensed under the SGI
 118             Free Software B License. For details, see
 119             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 120         </para>
 121     </refsect1>
 122 </refentry>