INQUIRE DEPTH CUE REPRESENTATION(3P+) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

INQUIRE DEPTH CUE REPRESENTATION − inquire depth cue representation for a given workstation

SYNOPSIS

C Syntax

void
pinq_dcue_rep ( ws, index, type, error_ind, rep )
Pintws;workstation identifier
Pintindex;polyline index
Pinq_typetype;type of returned value
Pint∗error_ind;OUT error indicator
Pdcue_bundle∗rep;OUT depth cue representation

Required PHIGS Operating States

(PHOP,WSOP, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE DEPTH CUE REPRESENTATION returns the attribute values of a specified entry in the workstation table of depth cue representations. See SET DEPTH CUE REPRESENTATION for a full description of the contents of the bundle table entry and a description of the depth cue representation table.

C Input Parameters

wsThe workstation identifier.

indexThe depth cue index.

typeAn enumerated value specifying whether the values to be returned are those originally specified by the application (PINQ_SET), or those resulting after PHIGS mapped them to ones available on the workstation (PINQ_REALIZED). A Pinq_type structure is defined as:

typedef enum {
PINQ_SET,
PINQ_REALIZED
} Pinq_type;

C Output Parameters

error_ind
A pointer to the location to store the error number of any error detected by this function.

repA pointer to a Pdcue_bundle data structure containing attribute values defining a depth cue representation. A Pdcue_bundle structure is defined as:

typedef struct {
Pdcue_modemode;/∗ depth cue mode ∗/
Pfloatref_planes[2];/∗ depth cue reference planes ∗/
Pfloatscaling[2];/∗ depth cue scaling ∗/
Pgcolrcolr;/∗ depth cue colour ∗/
} Pdcue_bundle;

Pdcue_mode is defined as:

typedef enum {
PSUPPRESSED,
PALLOWED
} Pdcue_mode;

ref_planes and scaling entries of 0 are back reference plane and corresponding scaling factors. ref_planes and scaling entries of 1 are front reference plane and corresponding scaling factors. These scaling factors define the portion of the primitive colour that should be combined with the depth cue colour, as a function of z in NPC.

Pgcolr is defined as:

typedef struct {
Pinttype;/∗ indirect, RGB, CIE, HSV, HLS ∗/
union {
     Pintind;/∗ index in workstation colour bundle table ∗/
     struct {
          Pfloatx;/∗ red, hue, etc. ∗/
          Pfloaty;/∗ green, saturation, lightness, etc. ∗/
          Pfloatz;/∗ blue, value, saturation, etc. ∗/
     } general;
} val;
} Pgcolr;

Execution

If the inquired information is available, the error indicator is returned as zero and values are returned in the output parameters.

If the specified depth cue index is not present in the depth cue table on the workstation and the specified type of returned value is Realized, the representation for the depth cue index zero is returned.

If the inquired information is not available, the values returned in the output parameters are undefined and the error indicator is set to one of the following error numbers to indicate the reason for nonavailability.

Since this is an inquiry function, ERROR HANDLING is not invoked when an error is detected by this function.

ERRORS

003Ignoring function, function requires state (PHOP,WSOP,∗,∗)

054Ignoring function, the specified workstation is not open

059Ignoring function, the specified workstation does not have output capability (that is, the workstation category is neither OUTPUT, OUTIN, nor MO)

101Ignoring function, the specified representation has not been defined

603Ignoring function, the depth cue index is less than zero

Museum