PEXSetEchoColor - PEX Escape to set Echo Color for Specified Renderer (5.1)


Synopsis

 
   void PEXSetEchoColor(
        Display *display,
        PEXRenderer renderer,
        int color_type,
        PEXColor *color
   )
 

Arguments

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

renderer
The resource identifier of a renderer.

color_type
The type of color (PEXColorTypeIndexed, PEXColorTypeRGB, PEXColorTypeCIE, PEXColorTypeHSV, PEXColorTypeHLS, PEXColorTypeRGB8 or PEXColorTypeRGB16).

color
The echo color.

Returns

None

Description

Invoke PEXSetEchoColor to conveniently access the PEXEscapeSetEchoColor escape in order to set the echo color for use by a renderer when echoing primitives.

This function is defined for compatibility with PEX 5.1 and PEXlib 5.1. Beginning with PEX 5.2 and PEXlib 5.2, you should instead use the standard echo color renderer attribute to control the renderer's echo color.

You can change a renderer's echo color at any time during rendering, so the echo color is fully dynamic. You cannot inquire the dynamics of the echo color (see PEXGetRendererDynamics). Lighting and shading for echoed primitives is implementation-dependent. You cannot inquire a renderer's echo color and the default value is implementation-dependent. Inquire the support of this escape by invoking the PEXGetEnumTypeInfo function.

Errors

BadPEXColorType
The specified color type is invalid or unsupported.

BadPEXRenderer
The specified renderer resource identifier is invalid.

BadValue
The PEXEscapeSetEchoColor escape is unsupported.

See Also

For a list of PEX Escape functions and related topics, see PEX Escapes.