glGetPolygonStipple function

Article
12/11/2020

The glGetPolygonStipple function returns the polygon stipple pattern.

Syntax

void WINAPI glGetPolygonStipple(
   GLubyte *mask
);

Parameters

mask: Returns the stipple pattern.

Return value

This function does not return a value.

Error codes

The following error code can be retrieved by the glGetError function.

Name	Meaning
GL_INVALID_OPERATION	The function was called between a call to glBegin and the corresponding call to glEnd.

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.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Gl.h
Library	Opengl32.lib
DLL	Opengl32.dll