PEXCopyPixmapToAlphaBuffer - Copy Pixmap to an Alpha Buffer (5.2)


Synopsis

 
   void PEXCopyPixmapToAlphaBuffer(
        Display *display,
        PEXRenderer renderer,
        Pixmap pixmap
   )
 

Arguments

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

renderer
The resource identifier of the renderer.

pixmap
The resource identifier of the pixmap containing the alpha values to copy to the alpha buffer bound to the drawable associated with the renderer.

Returns

None.

Description

Invoke PEXCopyPixmapToAlphaBuffer to copy the content of the specified pixmap into the alpha buffer.

If the renderer state attribute of the renderer specified by the renderer argument is PEXRendering or PEXMultipassRendering, then the renderer copies the content of the specified pixmap to the alpha buffer bound to the drawable associated with the renderer. The format of the values copied from the pixmap is implementation-dependent.

To determine the correct alpha buffer depth for copying the pixmap, see the PEXGetAncillaryBufferInfo function.

The renderer's clip list is not considered by this function.

If the renderer state is PEXPicking, then the values copied to the alpha buffer have an implementation-dependent effect.

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

Errors

BadAlloc
The implementation failed to allocate the alpha buffer.

BadPEXRenderer
The specified renderer resource identifier is invalid.

BadPixmap
The specified pixmap resource identifier is invalid.

BadMatch
The drawable associated with the renderer cannot have an alpha buffer.

BadMatch
The drawable depth is not the same as the alpha buffer bound to the drawable associated with the renderer.

BadMatch
The drawable's width or height do not match those of the drawable associated with the renderer.

See Also

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