PEXSetEchoColor(3) — Subroutines

Name

PEXSetEchoColor - PEX Escape to set Echo Color for Specified Renderer

Synopsis

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

Arguments

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

rendererThe resource identifier of a renderer.

color_typeThe type of color (PEXColorTypeIndexed, PEXColorTypeRGB, PEXColorTypeCIE, PEXColorTypeHSV, PEXColorTypeHLS, PEXColorTypeRGB8, PEXColorTypeRGB16).

colorThe echo color.

Returns

None

Description

This function is a convenient way to access the PEXEscapeSetEchoColor escape to set the echo color for use by a renderer when echoing primitives.

A renderer’s echo color can be changed at any time during rendering and is not inquirable through the renderer’s modification dynamics (see PEXGetRendererDynamics). Lighting and shading for echoed primitives is implementation-dependent. A renderer’s echo color can not be inquired and the default value is implementation-dependent. Support of this escape is inquirable via PEXGetEnumTypeInfo.

Data Structures

typedef XID             PEXRenderer;
typedef union {
    PEXColorIndexed     indexed;
    PEXColorRGB         rgb;
    PEXColorHSV         hsv;
    PEXColorHLS         hls;
    PEXColorCIE         cie;
    PEXColorRGB8        rgb8;
    PEXColorRGB16       rgb16;
} PEXColor;
typedef struct {
    PEXTableIndex       index;
    unsigned short      reserved;
} PEXColorIndexed;
typedef struct {
    float               red;
    float               green;
    float               blue;
} PEXColorRGB;
typedef struct {
    float               hue;
    float               saturation;
    float               value;
} PEXColorHSV;
typedef struct {
    float               hue;
    float               lightness;
    float               saturation;
} PEXColorHLS;
typedef struct {
    float               x;
    float               y;
    float               z;
} PEXColorCIE;
typedef struct {
    unsigned char       red;
    unsigned char       green;
    unsigned char       blue;
    unsigned char       reserved;
} PEXColorRGB8;
typedef struct {
    unsigned short      red;
    unsigned short      green;
    unsigned short      blue;
    unsigned short      reserved;
} PEXColorRGB16;

Errors

BadPEXColorType
The specified color type is invalid or unsupported.

BadPEXRenderer
The specified renderer resource identifier is invalid.

BadValueThe PEXEscapeSetEchoColor escape is unsupported.

Museum