PgSetPlaneMask(), PgSetPlaneMaskCx()

Protect video memory from being modified

Synopsis:

unsigned long PgSetPlaneMask( unsigned long mask);

unsigned long PgSetPlaneMaskCx( PhGC_t *gc,
                                unsigned long mask);

Library:

ph

Description:

These functions protect 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 these functions 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. These functions work only on some 8-bit drivers.

---

PgSetPlaneMask() works on the current graphics context, while you can specify the graphics context gc for PgSetPlaneMaskCx().

Returns:

The previous mask.

Classification:

Photon

See also:

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

“Drawing attributes” in the Raw Drawing and Animation chapter of the Photon Programmer's Guide