PEXOCCSetPlaneMask - Set Plane Mask (5.2)

Synopsis

 
   void PEXOCCSetPlaneMask(
        PEXOCC context,
        unsigned long mask
   )
 

Arguments

context

An OC context returned by a successful PEXCreateOCC call.

display (OCC)

A pointer to a display structure returned by a successful XOpenDisplay call.

resource_id (OCC)

The resource identifier of the renderer or structure.

req_type (OCC)

The request type for the output command (PEXOCRender, PEXOCStore, PEXOCRenderSingle or PEXOCStoreSingle).

mask

The plane mask.

Returns

None.

Description

Invoke PEXOCCSetPlaneMask to set the plane mask entry of the renderer's pipeline state according to the value you specify in mask.

The bits set to 1 in the plane mask determine which planes of the destination image buffer are affected by rendering requests. Each bit of the plane bitmask represents one plane of the image buffer. The least-significant bit of the plane bitmask (0x00000001) corresponds to the plane of a monochrome image buffer; additional planes are represented by the more significant bits. Specify the macro constant AllPlanes (defined in Xlib.h) to refer to all the planes.

The plane mask functions like the core X GC plane mask.

Except for all planes enabled, plane masking interacts with alpha blending, primitive antialiasing, transparency, and the drawing functions, except GXcopy, in an implementation-dependent way.

This function is a member of the global attribute set.

Errors

BadPEXRenderer

The specified renderer resource identifier is invalid.

BadPEXStructure

The specified structure resource identifier is invalid.

See Also

For an overview and for a list of all output attribute functions, see Output Attribute Functions.