<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN" "http://www.w3.org/TR/MathML2/dtd/xhtml-math11-f.dtd">
<html
	xmlns="http://www.w3.org/1999/xhtml"
	xmlns:mml="http://www.w3.org/1998/Math/MathML"
><head><title>glPolygonStipple</title><link rel="stylesheet" href="style.css" type="text/css"/><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"/><link rel="home" href="index.xml" title="PyOpenGL 2.0.1.07 Man Pages"/><link rel="up" href="reference-GL.xml" title="GL"/><link rel="previous" href="glPolygonOffset.3G.xml" title="glPolygonOffset"/><link rel="next" href="glPrioritizeTextures.3G.xml" title="glPrioritizeTextures"/></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">glPolygonStipple</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="glPolygonOffset.3G.xml">Prev</a> </td><th width="60%" align="center">GL</th><td width="20%" align="right"> <a accesskey="n" href="glPrioritizeTextures.3G.xml">Next</a></td></tr></table><hr/></div><div class="refentry" lang="en"><a name="glPolygonStipple.3G"/><div class="titlepage"/><div class="refnamediv"><a name="glPolygonStipple.3G-name"/><h2>Name</h2><p>glPolygonStipple, glPolygonStippleub &#8212; set the polygon stippling pattern</p></div><div class="refsynopsisdiv"><a name="glPolygonStipple.3G-c_spec"/><h2>C Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code>void <tt>glPolygonStipple</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>const GLubyte *<i><tt>mask</tt></i>);</code></td></tr></table></div><div class="refsynopsisdiv"><a name="glPolygonStipple.3G-python_spec"/><h2>Python Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code><tt>glPolygonStipple</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>mask</tt></i>) &#8594; <tt>None</tt></code></td></tr><tr><td valign="top"><code><tt>glPolygonStippleub</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>mask</tt></i>[][]) &#8594; <tt>None</tt></code></td></tr></table></div><div class="refsect1" lang="en"><a name="glPolygonStipple.3G-parameters"/><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><i><tt>mask</tt></i></span></dt><dd>
						Specifies a pointer to a <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
								<mml:mrow>
									<mml:mn>32</mml:mn>
									<mml:mo>×</mml:mo>
									<mml:mn>32</mml:mn>
								</mml:mrow>
							</mml:math> stipple pattern that will be unpacked from memory in the same way that <a href="glDrawPixels.3G.xml"><tt>glDrawPixels</tt></a> unpacks pixels.
					</dd></dl></div></div><div class="refsect1" lang="en"><a name="glPolygonStipple.3G-description"/><h2>Description</h2><p>
			Polygon stippling, like line stippling (see <a href="glLineStipple.3G.xml">glLineStipple</a>), masks out certain fragments produced by rasterization, creating a pattern. Stippling is independent
			of polygon antialiasing.
		</p><p>
			<i><tt>mask</tt></i> is a pointer to a <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
					<mml:mrow>
						<mml:mn>32</mml:mn>
						<mml:mo>×</mml:mo>
						<mml:mn>32</mml:mn>
					</mml:mrow>
				</mml:math> stipple pattern that is stored in memory just like the pixel data supplied to a <a href="glDrawPixels.3G.xml"><tt>glDrawPixels</tt></a> call with <span class="emphasis"><em>height</em></span>and <span class="emphasis"><em>width</em></span>both
			equal to 32, a pixel of <tt>GL_COLOR_INDEX</tt>, and data type of <tt>GL_BITMAP</tt>. That is,
			the stipple pattern is represented as a <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
					<mml:mrow>
						<mml:mn>32</mml:mn>
						<mml:mo>×</mml:mo>
						<mml:mn>32</mml:mn>
					</mml:mrow>
				</mml:math> array of 1-bit color indices packed in unsigned bytes. <tt>glPixelStore</tt> parameters like <tt>GL_UNPACK_SWAP_BYTES</tt> and
			<tt>GL_UNPACK_LSB_FIRST</tt> affect the assembling of the bits into a stipple pattern. Pixel transfer
			operations (shift, offset, pixel map) are not applied to the stipple image, however.
		</p><p>
			To enable and disable polygon stippling, call <a href="glEnable.3G.xml"><tt>glEnable</tt></a> and <a href="glEnable.3G.xml"><tt>glDisable</tt></a> with argument <tt>GL_POLYGON_STIPPLE</tt>. Polygon stippling is
			initially disabled. If it's enabled, a rasterized polygon fragment with window coordinates <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
					<mml:msub>
						<mml:mi>x</mml:mi>
						<mml:mi>w</mml:mi>
					</mml:msub>
				</mml:math> and <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
					<mml:msub>
						<mml:mi>y</mml:mi>
						<mml:mi>w</mml:mi>
					</mml:msub>
				</mml:math> is sent to the next stage of the GL if and only if the (<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
					<mml:mrow>
						<mml:msub>
							<mml:mi>x</mml:mi>
							<mml:mi>w</mml:mi>
						</mml:msub>
						<mml:mi>mod</mml:mi>
						<mml:mn>32</mml:mn>
					</mml:mrow>
				</mml:math>)th bit in the (<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
					<mml:mrow>
						<mml:msub>
							<mml:mi>y</mml:mi>
							<mml:mi>w</mml:mi>
						</mml:msub>
						<mml:mi>mod</mml:mi>
						<mml:mn>32</mml:mn>
					</mml:mrow>
				</mml:math>)th row of the stipple pattern is 1 (one). When polygon stippling is disabled, it is as if the stipple
			pattern consists of all 1's.
		</p></div><div class="refsect1" lang="en"><a name="glPolygonStipple.3G-errors"/><h2>Errors</h2><p>
			<tt>GL_INVALID_OPERATION</tt> is generated if <tt>glPolygonStipple</tt> is executed between the
			execution of <a href="glBegin.3G.xml"><tt>glBegin</tt></a> and the corresponding execution of <a href="glBegin.3G.xml"><tt>glEnd</tt></a>.
		</p></div><div class="refsect1" lang="en"><a name="glPolygonStipple.3G-associated_gets"/><h2>Associated Gets</h2><p>
			<a href="glGetPolygonStipple.3G.xml"><tt>glGetPolygonStipple</tt></a>
		</p><p>
			<a href="glIsEnabled.3G.xml"><tt>glIsEnabled</tt></a> with argument <tt>GL_POLYGON_STIPPLE</tt>
		</p></div><div class="refsect1" lang="en"><a name="glPolygonStipple.3G-see_also"/><h2>See Also</h2><p>
			<span class="simplelist"><a href="glDrawPixels.3G.xml">glDrawPixels</a>, <a href="glLineStipple.3G.xml">glLineStipple</a>, <a href="glPixelStore.3G.xml">glPixelStore</a>, <a href="glPixelTransfer.3G.xml">glPixelTransfer</a></span>
		</p></div></div><div class="navfooter"><hr/><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="glPolygonOffset.3G.xml">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="reference-GL.xml">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="glPrioritizeTextures.3G.xml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">glPolygonOffset </td><td width="20%" align="center"><a accesskey="h" href="index.xml">Home</a></td><td width="40%" align="right" valign="top"> glPrioritizeTextures</td></tr></table></div></body></html>
