upstream-doc/man2/xhtml/glGetPolygonStipple.xml

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   2 <!-- saved from url=(0013)about:internet -->
   3 <?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" /><title>glGetPolygonStipple</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glGetPolygonStipple"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetPolygonStipple — return the polygon stipple pattern</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glGetPolygonStipple</b>(</code></td><td>GLubyte *  </td><td><var class="pdparam">pattern</var><code>)</code>;</td></tr></table></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>pattern</code></em></span></dt><dd><p>
   4                     Returns the stipple pattern. The initial value is all 1's.
   5                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
   6             <code class="function">glGetPolygonStipple</code> returns to <em class="parameter"><code>pattern</code></em> a
   7             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
   8
   9                 <mml:mrow>
  10                     <mml:mn>32</mml:mn>
  11                     <mml:mo>×</mml:mo>
  12                     <mml:mn>32</mml:mn>
  13                 </mml:mrow>
  14             </mml:math>
  15             polygon stipple pattern.
  16             The pattern is packed into memory as if <a class="citerefentry" href="glReadPixels.xml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a>
  17             with both <span class="emphasis"><em>height</em></span> and <span class="emphasis"><em>width</em></span> of 32,
  18             <span class="emphasis"><em>type</em></span> of <code class="constant">GL_BITMAP</code>,
  19             and <span class="emphasis"><em>format</em></span> of <code class="constant">GL_COLOR_INDEX</code> were called,
  20             and the stipple pattern were stored in an internal
  21             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  22
  23                 <mml:mrow>
  24                     <mml:mn>32</mml:mn>
  25                     <mml:mo>×</mml:mo>
  26                     <mml:mn>32</mml:mn>
  27                 </mml:mrow>
  28             </mml:math>
  29             color
  30             index buffer.
  31             Unlike <a class="citerefentry" href="glReadPixels.xml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a>,
  32             however,
  33             pixel transfer operations
  34             (shift, offset, pixel map)
  35             are not applied to the returned stipple image.
  36         </p><p>
  37             If a non-zero named buffer object is bound to the <code class="constant">GL_PIXEL_PACK_BUFFER</code> target
  38             (see <a class="citerefentry" href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>) while a polygon stipple pattern is
  39             requested, <em class="parameter"><code>pattern</code></em> is treated as a byte offset into the buffer object's data store.
  40         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  41             If an error is generated,
  42             no change is made to the contents of <em class="parameter"><code>pattern</code></em>.
  43         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  44             <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to the
  45             <code class="constant">GL_PIXEL_PACK_BUFFER</code> target and the buffer object's data store is currently mapped.
  46         </p><p>
  47             <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to the
  48             <code class="constant">GL_PIXEL_PACK_BUFFER</code> target and the data would be packed to the buffer
  49             object such that the memory writes required would exceed the data store size.
  50         </p><p>
  51             <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glGetPolygonStipple</code>
  52             is executed between the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a>
  53             and the corresponding execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
  54         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  55             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_PIXEL_PACK_BUFFER_BINDING</code>
  56         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  57             <a class="citerefentry" href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>,
  58             <a class="citerefentry" href="glPixelTransfer.xml"><span class="citerefentry"><span class="refentrytitle">glPixelTransfer</span></span></a>,
  59             <a class="citerefentry" href="glPolygonStipple.xml"><span class="citerefentry"><span class="refentrytitle">glPolygonStipple</span></span></a>,
  60             <a class="citerefentry" href="glReadPixels.xml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a>
  61         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  62             Copyright <span class="trademark"></span>© 1991-2006
  63             Silicon Graphics, Inc. This document is licensed under the SGI
  64             Free Software B License. For details, see
  65             <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
  66         </p></div></div></body></html>