glGetPolygonStipple

The glGetPolygonStipple function returns the polygon stipple pattern.

void glGetPolygonStipple(
  GLubyte *mask);

Parameters

• mask
  Returns the stipple pattern.

Remarks

The glGetPolygonStipple function returns a 32x32 polygon stipple pattern through the mask parameter. The pattern is packed into memory as if glReadPixels with both height and width of 32, type of GL_BITMAP, and format of GL_COLOR_INDEX were called, and the stipple pattern were stored in an internal 32x32 color-index buffer. Unlike glReadPixels, however, pixel-transfer operations (shift, offset, and pixel map) are not applied to the returned stipple image.

If an error is generated, no change is made to the contents of mask.

Error Codes

The following is the error code generated and its condition.

Requirements

**  Windows NT/2000:** Requires Windows NT 3.5 or later.
**  Windows 95/98:** Requires Windows 95 or later. Available as a redistributable for Windows 95.
**  Header:** Declared in Gl.h.
**  Library:** Use Opengl32.lib.

See Also

glBegin, glEnd, glPixelStore, glPixelTransfer, glPolygonStipple, glReadPixels