glGetPolygonStipple

The glGetPolygonStipple function returns the polygon stipple pattern.

void glGetPolygonStipple(
  GLubyte * mask   
);
 

Parameters

mask
Returns the stipple pattern.

Remarks

The glGetPolygonStipple function returns to mask a 32x32 polygon stipple pattern. 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 are the error codes generated and their conditions.

Error Code Condition
GL_INVALID_OPERATION glGetPolygonStipple was called between a call to glBegin and the corresponding call to glEnd.

QuickInfo

  Windows NT: Use version 3.5 and later.
  Windows: Use Windows 95 and later.
  Windows CE: Unsupported.
  Header: Declared in gl.h.
  Import Library: Link with opengl32.lib.

See Also

glBegin, glEnd, glPixelStore, glPixelTransfer, glPolygonStipple, glReadPixels