PEXClearRenderer - Clear Renderer Buffers (5.2)

Synopsis 

 
   void PEXClearRenderer(
        Display *display,
        PEXRenderer renderer,
        unsigned long buffer_mask
   )

Arguments

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

renderer
The resource identifier of the renderer.

buffer_mask
A single word bitmask containing the logical OR of any of the following symbols: PEXClearRendererImage, PEXClearRendererZ or PEXClearRendererAlpha.

Returns

None.

Description

Invoke PEXClearRenderer to clear the buffers of the drawable associated with the renderer specified by renderer when the renderer is in PEXRendering, PEXPicking, or PEXMultipassRendering states.

PEXlib defines the following bits:

PEXClearRendererImage -
the renderer draws the renderer's background color into the drawable's image buffer in the regions indicated by the renderer's clip list.

PEXClearRendererZ -
the renderer clears the entire Z-buffer, if any, to the renderer's clear Z value in the regions indicated by the renderer's clip list.

PEXClearRendererAlpha - the renderer draws the renderer's background color into the entire alpha buffer that is associated with the renderer, if any. Clear alpha buffer also respects the renderer's clip list. PEXlib uses the background color's alpha component to clear the alpha buffer. If there is no alpha component, then the alpha value defaults to 1.0.

If the renderer's state is PEXIdle, then this function has no effect.

Errors

BadAlloc
The implementation failed to allocate the alpha buffer or Z-buffer.

BadPEXRenderer
The specified renderer resource identifier is invalid.

See Also

For a list of all Renderer functions and related topics, see Rendering.