pset_depth_cue_rep(3g) — Subroutines

Name

pset_depth_cue_rep − Associates a depth cue index with related depth cue information.

Operating States: PHOP, WSOP, ∗, ∗
PHIGS PLUS function

Syntax

void pset_depth_cue_rep (
Pint                    wsid,    /∗ (I) Workstation identifier ∗/
Pint                    index,   /∗ (I) Depth cue index ∗/
const Pdepth_cue_rep   ∗rep      /∗ (I) Depth cue representation ∗/
)

Data Structures

typedef struct {
    Pdepth_cue_mode     mode;           /∗ depth cue mode ∗/
    Pfloat              ref_planes[2]; /∗ depth cue reference planes
                                           (minimum, maximum) ∗/
    Pfloat              scale[2];       /∗ depth cue scale factors
                                           (minimum, maximum) ∗/
    Pgcolr              gcolr;          /∗ depth cue color ∗/
} Pdepth_cue_rep;
    typedef enum {
        PDEPTH_CUE_SUPPR,      /∗ No depth cueing ∗/
        PDEPTH_CUE_ALLOWED     /∗ Perform depth cueing ∗/
    } Pdepth_cue_mode;
    typedef struct {
        Pint     colr_type;   /∗ color type ∗/
        Pcolrv   colr_value; /∗ color value ∗/
    } Pgcolr;
        typedef union {
            Pint         colr_ind;    /∗ color index ∗/
            Pcolr_rep    colr_rep;    /∗ color representation ∗/
        } Pcolrv;
            typedef union {
                Prgb        rgb;       /∗ red, green, and blue color
                                          specification ∗/
                Pcieluv     cieluv;    /∗ CIELUV color specification ∗/
                Phls        hls;       /∗ hue, lightness, and saturation
                                          color specification ∗/
                Phsv        hsv;       /∗ hue, saturation, and value
                                          color specification ∗/
                Pdata       unsupp;    /∗ color in an unsupported color
                                          model ∗/
                int         impl_dep; /∗ implementation-defined ∗/
            } Pcolr_rep;
                typedef struct {
                    Pfloat    red;     /∗ red intensity ∗/
                    Pfloat    green;   /∗ green intensity ∗/
                    Pfloat    blue;    /∗ blue intensity ∗/
                } Prgb;
                typedef struct {
                    Pfloat    cieluv_x;      /∗ x coefficient ∗/
                    Pfloat    cieluv_y;      /∗ y coefficient ∗/
                    Pfloat    cieluv_y_lum; /∗ y luminance ∗/
                } Pcieluv;
                typedef struct {
                    Pfloat    hue;         /∗ hue ∗/
                    Pfloat    lightness;   /∗ lightness ∗/
                    Pfloat    satur;       /∗ saturation ∗/
                } Phls;
                typedef struct {
                    Pfloat    hue;      /∗ hue ∗/
                    Pfloat    satur;    /∗ saturation ∗/
                    Pfloat    value;    /∗ value ∗/
                } Phsv;
                typedef struct {
                    size_t    size;     /∗ size of data ∗/
                    void     ∗data;     /∗ pointer to the data ∗/
                } Pdata;

Constants

Data Structure Constants     Constant         Description
---------------------------------------------------------------------------
Color types                  PCOLR_INDIRECT   Indirect (indexed) color
                             PCOLR_RGB        Direct specification of red,
                                              green, and blue
                             PCOLR_CIELUV     Direct specification in the
                                              format of the Commission
                                              Internationale de l’Eclairage
                             PCOLR_HSV        Direct specification of hue,
                                              saturation, and value
                             PCOLR_HLS        Direct specification of hue,
                                              lightness, and saturation
---------------------------------------------------------------------------

Description

pset_depth_cue_rep associates a depth cue index with the following related depth cue criteria:

•Depth cue mode

•Depth cue reference planes

•Depth cue scaling

•Depth cue color values in the depth cue table, on the workstation specified by the workstation identifier

This function associates the specified index with the specified depth cue values to create or modify the depth cue table entry. Each entry contains a depth cue mode, two depth cue reference planes, two depth cue scale factors, and a depth cue color. Depth cue index 0 cannot be modified.

A depth cue mode of SUPPRESSED or ALLOWED disables or enables the effects of depth cueing. The depth cue reference planes are two z values in normalized projection coordinates that define a back reference plane and a front reference plane for depth cueing. The depth cue scale factors are two values between 0.0 and 1.0. These values correspond to the z values of the depth cue reference planes and define the portion of the primitive’s color and the depth cue color that will be combined as a function of z in normalized projection coordinates.

Depth cue color consists of three real values. See the pset_colr_model and pset_colr_rep functions for information about color models and representation.

Digital PHIGS defines depth cueing for all primitives, unlike lighting and shading, which apply to area-defining primitives only.