glGetPolygonStipple

Name

glGetPolygonStipple — return the polygon stipple pattern

C Specification

void glGetPolygonStipple( GLubyte * pattern);

Parameters

pattern: Returns the stipple pattern. The initial value is all 1's.

Description

glGetPolygonStipple returns to pattern a 32 × 32 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 32 × 32 color index buffer. Unlike glReadPixels, however, pixel transfer operations (shift, offset, pixel map) are not applied to the returned stipple image.

If a non-zero named buffer object is bound to the GL_PIXEL_PACK_BUFFER target (see glBindBuffer) while a polygon stipple pattern is requested, pattern is treated as a byte offset into the buffer object's data store.

Notes

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

Errors

GL_INVALID_OPERATION is generated if a non-zero buffer object name is bound to the GL_PIXEL_PACK_BUFFER target and the buffer object's data store is currently mapped.

GL_INVALID_OPERATION is generated if a non-zero buffer object name is bound to the GL_PIXEL_PACK_BUFFER target and the data would be packed to the buffer object such that the memory writes required would exceed the data store size.

GL_INVALID_OPERATION is generated if glGetPolygonStipple is executed between the execution of glBegin and the corresponding execution of glEnd.

Associated Gets

glGet with argument GL_PIXEL_PACK_BUFFER_BINDING