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


Synopsis

 
   void PEXCopyPixmapToZBuffer(
        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 Z values to copy to the Z-buffer bound to the drawable associated with the renderer.

Returns

None.

Description

Invoke PEXCopyPixmapToZBuffer to copy the content of the specified pixmap into the Z-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 Z-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 Z-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 Z-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 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.