[clinton/guile-figl.git] / upstream-doc / man2 / glPolygonStipple.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glPolygonStipple">
    <refmeta>
        <refmetainfo>
            <copyright>
                <year>1991-2006</year>
                <holder>Silicon Graphics, Inc.</holder>
            </copyright>
        </refmetainfo>
        <refentrytitle>glPolygonStipple</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glPolygonStipple</refname>
        <refpurpose>set the polygon stippling pattern</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glPolygonStipple</function></funcdef>
                <paramdef>const GLubyte * <parameter>pattern</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <!-- eqn: ignoring delim $$ -->
    <refsect1 id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>pattern</parameter></term>
            <listitem>
                <para>
                    Specifies a pointer to a 
                    <inlineequation><mml:math>
                        <!-- eqn: 32  times  32:-->
                        <mml:mrow>
                            <mml:mn>32</mml:mn>
                            <mml:mo>&times;</mml:mo>
                            <mml:mn>32</mml:mn>
                        </mml:mrow>
                    </mml:math></inlineequation>
                    stipple pattern that will be unpacked
                    from memory in the same way that <citerefentry><refentrytitle>glDrawPixels</refentrytitle></citerefentry> unpacks pixels.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            Polygon stippling,
            like line stippling
            (see <citerefentry><refentrytitle>glLineStipple</refentrytitle></citerefentry>),
            masks out certain fragments produced by rasterization,
            creating a pattern.
            Stippling is independent of polygon antialiasing.
        </para>
        <para>
            <parameter>pattern</parameter> is a pointer to a 
            <inlineequation><mml:math>
                <!-- eqn: 32  times  32:-->
                <mml:mrow>
                    <mml:mn>32</mml:mn>
                    <mml:mo>&times;</mml:mo>
                    <mml:mn>32</mml:mn>
                </mml:mrow>
            </mml:math></inlineequation>
            stipple pattern that is stored
            in memory just like the pixel data supplied to a <citerefentry><refentrytitle>glDrawPixels</refentrytitle></citerefentry>
            call with
            <emphasis></emphasis>
            height
            and
            <emphasis>width</emphasis>
            both equal to 32, a pixel format
            of <constant>GL_COLOR_INDEX</constant>, and data type
            of <constant>GL_BITMAP</constant>.
            That is,
            the stipple pattern is represented as a 
            <inlineequation><mml:math>
                <!-- eqn: 32  times  32:-->
                <mml:mrow>
                    <mml:mn>32</mml:mn>
                    <mml:mo>&times;</mml:mo>
                    <mml:mn>32</mml:mn>
                </mml:mrow>
            </mml:math></inlineequation>
            array
            of 1-bit color indices packed in unsigned bytes.
            <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry> parameters like <constant>GL_UNPACK_SWAP_BYTES</constant>
            and <constant>GL_UNPACK_LSB_FIRST</constant> 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.
        </para>
        <para>
            If a non-zero named buffer object is bound to the <constant>GL_PIXEL_UNPACK_BUFFER</constant> target 
            (see <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>) while a stipple pattern is
            specified, <parameter>pattern</parameter> is treated as a byte offset into the buffer object's data store.
        </para>
        <para>
            To enable and disable polygon stippling, call
            <citerefentry><refentrytitle>glEnable</refentrytitle></citerefentry> and <citerefentry><refentrytitle>glDisable</refentrytitle></citerefentry>
            with argument <constant>GL_POLYGON_STIPPLE</constant>. Polygon stippling is initially
            disabled. If it's enabled,
            a rasterized polygon fragment with window coordinates 
            <inlineequation><mml:math>
                <!-- eqn: x sub w:-->
                <mml:msub><mml:mi mathvariant="italic">x</mml:mi>
                <mml:mi mathvariant="italic">w</mml:mi>
                </mml:msub>
            </mml:math></inlineequation>
            and 
            <inlineequation><mml:math>
                <!-- eqn: y sub w:-->
                <mml:msub><mml:mi mathvariant="italic">y</mml:mi>
                <mml:mi mathvariant="italic">w</mml:mi>
                </mml:msub>
            </mml:math></inlineequation>
            is sent to the next stage of the GL if and only if the
            (<inlineequation><mml:math>
                <!-- eqn: x sub w mod 32:-->
                <mml:mrow>
                    <mml:msub><mml:mi mathvariant="italic">x</mml:mi>
                    <mml:mi mathvariant="italic">w</mml:mi>
                    </mml:msub>
                    <mml:mo>%</mml:mo>
                    <mml:mn>32</mml:mn>
                </mml:mrow>
            </mml:math></inlineequation>)th
            bit in the 
            (<inlineequation><mml:math>
                <!-- eqn: y sub w mod 32:-->
                <mml:mrow>
                    <mml:msub><mml:mi mathvariant="italic">y</mml:mi>
                    <mml:mi mathvariant="italic">w</mml:mi>
                    </mml:msub>
                    <mml:mo>%</mml:mo>
                    <mml:mn>32</mml:mn>
                </mml:mrow>
            </mml:math></inlineequation>)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.
        </para>
    </refsect1>
    <refsect1 id="errors"><title>Errors</title>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
            <constant>GL_PIXEL_UNPACK_BUFFER</constant> target and the buffer object's data store is currently mapped.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
            <constant>GL_PIXEL_UNPACK_BUFFER</constant> target and the data would be unpacked from the buffer 
            object such that the memory reads required would exceed the data store size.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if <function>glPolygonStipple</function>
            is executed between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>
            and the corresponding execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
        </para>
    </refsect1>
    <refsect1 id="associatedgets"><title>Associated Gets</title>
        <para>
            <citerefentry><refentrytitle>glGetPolygonStipple</refentrytitle></citerefentry>
        </para>
        <para>
            <citerefentry><refentrytitle>glIsEnabled</refentrytitle></citerefentry> with argument <constant>GL_POLYGON_STIPPLE</constant>
        </para>
        <para>
            <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_PIXEL_UNPACK_BUFFER_BINDING</constant>
        </para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glDrawPixels</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glLineStipple</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glPixelTransfer</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"></trademark> 1991-2006
            Silicon Graphics, Inc. This document is licensed under the SGI
            Free Software B License. For details, see
            <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
        </para>
    </refsect1>
</refentry>
Commit	Line	Data
7faf1d71 AW	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="glPolygonStipple">
	5	<refmeta>
	6	<refmetainfo>
	7	<copyright>
	8	<year>1991-2006</year>
	9	<holder>Silicon Graphics, Inc.</holder>
	10	</copyright>
	11	</refmetainfo>
	12	<refentrytitle>glPolygonStipple</refentrytitle>
	13	<manvolnum>3G</manvolnum>
	14	</refmeta>
	15	<refnamediv>
	16	<refname>glPolygonStipple</refname>
	17	<refpurpose>set the polygon stippling pattern</refpurpose>
	18	</refnamediv>
	19	<refsynopsisdiv><title>C Specification</title>
	20	<funcsynopsis>
	21	<funcprototype>
	22	<funcdef>void <function>glPolygonStipple</function></funcdef>
	23	<paramdef>const 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	Specifies a pointer to a
	35	<inlineequation><mml:math>
	36	<!-- eqn: 32 times 32:-->
	37	<mml:mrow>
	38	<mml:mn>32</mml:mn>
	39	<mml:mo>×</mml:mo>
	40	<mml:mn>32</mml:mn>
	41	</mml:mrow>
	42	</mml:math></inlineequation>
	43	stipple pattern that will be unpacked
	44	from memory in the same way that <citerefentry><refentrytitle>glDrawPixels</refentrytitle></citerefentry> unpacks pixels.
	45	</para>
	46	</listitem>
	47	</varlistentry>
	48	</variablelist>
	49	</refsect1>
	50	<refsect1 id="description"><title>Description</title>
	51	<para>
	52	Polygon stippling,
	53	like line stippling
	54	(see <citerefentry><refentrytitle>glLineStipple</refentrytitle></citerefentry>),
	55	masks out certain fragments produced by rasterization,
	56	creating a pattern.
	57	Stippling is independent of polygon antialiasing.
	58	</para>
	59	<para>
	60	<parameter>pattern</parameter> is a pointer to a
	61	<inlineequation><mml:math>
	62	<!-- eqn: 32 times 32:-->
	63	<mml:mrow>
	64	<mml:mn>32</mml:mn>
65	<mml:mo>×</mml:mo>
66	<mml:mn>32</mml:mn>
67	</mml:mrow>
68	</mml:math></inlineequation>
69	stipple pattern that is stored
70	in memory just like the pixel data supplied to a <citerefentry><refentrytitle>glDrawPixels</refentrytitle></citerefentry>
71	call with
72	<emphasis></emphasis>
73	height
74	and
75	<emphasis>width</emphasis>
76	both equal to 32, a pixel format
77	of <constant>GL_COLOR_INDEX</constant>, and data type
78	of <constant>GL_BITMAP</constant>.
79	That is,
80	the stipple pattern is represented as a
81	<inlineequation><mml:math>
82	<!-- eqn: 32 times 32:-->
83	<mml:mrow>
84	<mml:mn>32</mml:mn>
85	<mml:mo>×</mml:mo>
86	<mml:mn>32</mml:mn>
87	</mml:mrow>
88	</mml:math></inlineequation>
89	array
90	of 1-bit color indices packed in unsigned bytes.
91	<citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry> parameters like <constant>GL_UNPACK_SWAP_BYTES</constant>
92	and <constant>GL_UNPACK_LSB_FIRST</constant> affect the assembling of the bits into a
93	stipple pattern.
94	Pixel transfer operations
95	(shift, offset, pixel map)
96	are not applied to the stipple image,
97	however.
98	</para>
99	<para>
100	If a non-zero named buffer object is bound to the <constant>GL_PIXEL_UNPACK_BUFFER</constant> target
101	(see <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>) while a stipple pattern is
102	specified, <parameter>pattern</parameter> is treated as a byte offset into the buffer object's data store.
103	</para>
104	<para>
105	To enable and disable polygon stippling, call
106	<citerefentry><refentrytitle>glEnable</refentrytitle></citerefentry> and <citerefentry><refentrytitle>glDisable</refentrytitle></citerefentry>
107	with argument <constant>GL_POLYGON_STIPPLE</constant>. Polygon stippling is initially
108	disabled. If it's enabled,
109	a rasterized polygon fragment with window coordinates
110	<inlineequation><mml:math>
111	<!-- eqn: x sub w:-->
112	<mml:msub><mml:mi mathvariant="italic">x</mml:mi>
113	<mml:mi mathvariant="italic">w</mml:mi>
114	</mml:msub>
115	</mml:math></inlineequation>
116	and
117	<inlineequation><mml:math>
118	<!-- eqn: y sub w:-->
119	<mml:msub><mml:mi mathvariant="italic">y</mml:mi>
120	<mml:mi mathvariant="italic">w</mml:mi>
121	</mml:msub>
122	</mml:math></inlineequation>
123	is sent to the next stage of the GL if and only if the
124	(<inlineequation><mml:math>
125	<!-- eqn: x sub w mod 32:-->
126	<mml:mrow>
127	<mml:msub><mml:mi mathvariant="italic">x</mml:mi>
128	<mml:mi mathvariant="italic">w</mml:mi>
129	</mml:msub>
130	<mml:mo>%</mml:mo>
131	<mml:mn>32</mml:mn>
132	</mml:mrow>
133	</mml:math></inlineequation>)th
134	bit in the
135	(<inlineequation><mml:math>
136	<!-- eqn: y sub w mod 32:-->
137	<mml:mrow>
138	<mml:msub><mml:mi mathvariant="italic">y</mml:mi>
139	<mml:mi mathvariant="italic">w</mml:mi>
140	</mml:msub>
141	<mml:mo>%</mml:mo>
142	<mml:mn>32</mml:mn>
143	</mml:mrow>
144	</mml:math></inlineequation>)th
145	row
146	of the stipple pattern is 1 (one).
147	When polygon stippling is disabled, it is as if the stipple pattern
148	consists of all 1's.
149	</para>
150	</refsect1>
151	<refsect1 id="errors"><title>Errors</title>
152	<para>
153	<constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
154	<constant>GL_PIXEL_UNPACK_BUFFER</constant> target and the buffer object's data store is currently mapped.
155	</para>
156	<para>
157	<constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
158	<constant>GL_PIXEL_UNPACK_BUFFER</constant> target and the data would be unpacked from the buffer
159	object such that the memory reads required would exceed the data store size.
160	</para>
161	<para>
162	<constant>GL_INVALID_OPERATION</constant> is generated if <function>glPolygonStipple</function>
163	is executed between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>
164	and the corresponding execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
165	</para>
166	</refsect1>
167	<refsect1 id="associatedgets"><title>Associated Gets</title>
168	<para>
169	<citerefentry><refentrytitle>glGetPolygonStipple</refentrytitle></citerefentry>
170	</para>
171	<para>
172	<citerefentry><refentrytitle>glIsEnabled</refentrytitle></citerefentry> with argument <constant>GL_POLYGON_STIPPLE</constant>
173	</para>
174	<para>
175	<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_PIXEL_UNPACK_BUFFER_BINDING</constant>
176	</para>
177	</refsect1>
178	<refsect1 id="seealso"><title>See Also</title>
179	<para>
180	<citerefentry><refentrytitle>glDrawPixels</refentrytitle></citerefentry>,
181	<citerefentry><refentrytitle>glLineStipple</refentrytitle></citerefentry>,
182	<citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>,
183	<citerefentry><refentrytitle>glPixelTransfer</refentrytitle></citerefentry>
184	</para>
185	</refsect1>
186	<refsect1 id="Copyright"><title>Copyright</title>
187	<para>
188	Copyright <trademark class="copyright"></trademark> 1991-2006
189	Silicon Graphics, Inc. This document is licensed under the SGI
190	Free Software B License. For details, see
191	<ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
192	</para>
193	</refsect1>
194	</refentry>