53 lines
1.4 KiB
Plaintext
53 lines
1.4 KiB
Plaintext
|
'\" e
|
||
|
|
'\"! eqn | mmdoc
|
||
|
|
'\"macro stdmacro
|
||
|
|
.ds Vn Version 1.2
|
||
|
|
.ds Dt 24 September 1999
|
||
|
|
.ds Re Release 1.2.1
|
||
|
|
.ds Dp Jan 14 18:30
|
||
|
|
.ds Dm 01 getpolygo
|
||
|
|
.ds Xs 49553 4 getpolygonstipple.gl
|
||
|
|
.TH GLGETPOLYGONSTIPPLE 3G
|
||
|
|
.SH NAME
|
||
|
|
.B "glGetPolygonStipple
|
||
|
|
\- return the polygon stipple pattern
|
||
|
|
|
||
|
|
.SH C SPECIFICATION
|
||
|
|
void \f3glGetPolygonStipple\fP(
|
||
|
|
GLubyte \fI*mask\fP )
|
||
|
|
.nf
|
||
|
|
.fi
|
||
|
|
|
||
|
|
.EQ
|
||
|
|
delim $$
|
||
|
|
.EN
|
||
|
|
.SH PARAMETERS
|
||
|
|
.TP \w'\f2mask\fP\ \ 'u
|
||
|
|
\f2mask\fP
|
||
|
|
Returns the stipple pattern. The initial value is all 1's.
|
||
|
|
.SH DESCRIPTION
|
||
|
|
\%\f3glGetPolygonStipple\fP returns to \f2mask\fP a $32 ~times~ 32$ polygon stipple pattern.
|
||
|
|
The pattern is packed into memory as if \%\f3glReadPixels\fP
|
||
|
|
with both \f2height\fP and \f2width\fP of 32,
|
||
|
|
\f2type\fP of \%\f3GL_BITMAP\fP,
|
||
|
|
and \f2format\fP of \%\f3GL_COLOR_INDEX\fP were called,
|
||
|
|
and the stipple pattern were stored in an internal $32 ~times~ 32$ color
|
||
|
|
index buffer.
|
||
|
|
Unlike \%\f3glReadPixels\fP,
|
||
|
|
however,
|
||
|
|
pixel transfer operations
|
||
|
|
(shift, offset, pixel map)
|
||
|
|
are not applied to the returned stipple image.
|
||
|
|
.SH NOTES
|
||
|
|
If an error is generated,
|
||
|
|
no change is made to the contents of \f2mask\fP.
|
||
|
|
.SH ERRORS
|
||
|
|
\%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glGetPolygonStipple\fP
|
||
|
|
is executed between the execution of \%\f3glBegin\fP
|
||
|
|
and the corresponding execution of \%\f3glEnd\fP.
|
||
|
|
.SH SEE ALSO
|
||
|
|
\%\f3glPixelStore(3G)\fP,
|
||
|
|
\%\f3glPixelTransfer(3G)\fP,
|
||
|
|
\%\f3glPolygonStipple(3G)\fP,
|
||
|
|
\%\f3glReadPixels(3G)\fP
|