PgSetPlaneMask()

Protect video memory from being modified

Synopsis:

unsigned long PgSetPlaneMask( unsigned long mask);

Description:

This function protects planes of video memory from being modified. Each bit in the specified mask corresponds to a plane of video memory: a value of 0 enables access to the plane, a value of 1 protects the plane.

The effect of this function depends on the physical video mode. If the video mode is "true color," the mask will protect parts of the RGB value of the pixel that's in video memory. If the video mode is palette based, the mask will protect parts of the palette index of the pixel that's in video memory. This function works only on some 8-bit drivers.

Returns:

The previous mask.

Classification:

Photon

See also:

PgDefaultMode(), PgSetFillColor(), PgSetStrokeColor(), PgSetTextColor()