PEXCopyZBufferToPixmap - Copy Z-Buffer to a Pixmap (5.2)

Synopsis 

 
   void PEXCopyZBufferToPixmap(
        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 to receive the contents from the Z-buffer bound to the drawable associated with the renderer.

Returns

None.

Description

Invoke PEXCopyZBufferToPixmap to copy the content of the Z-buffer to the specified pixmap.

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 Z-buffer bound to the drawable associated with the renderer to the specified pixmap. The format of the values copied to the pixmap is implementation-dependent.

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

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

If the renderer state is PEXPicking, then the validity of the values copied from the Z-buffer is implementation-dependent.

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

Errors

BadAlloc
The implementation failed to allocate the Z-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 a Z-buffer.

BadMatch
The drawable depth is not the same as the Z-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.