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

NAME

INQUIRE PREDEFINED DEPTH CUE REPRESENTATION − inquire predefined depth cue representation for the specified workstation type

SYNOPSIS

C Syntax

void
pinq_pred_dcue_rep ( type, index, error_ind, bundle )
Pinttype;workstation type
Pintindex;predefined index
Pint∗error_ind;OUT error indicator
Pdcue_bundle∗bundle;OUT predefined depth cue rep

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE PREDEFINED DEPTH CUE REPRESENTATION returns the attribute values of a specified entry in the workstation type’s table of predefined 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

typeThe workstation type.

indexThe index of the predefined entry to be returned.

C Output Parameters

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

bundleA pointer to a Pdcue_bundle data structure containing attribute values defining a predefined depth cue representation. A Pdcue_bundle structure is defined in phigs.h as follows:

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;

Entry 0 in ref_planes is the back reference plane. Entry 0 in scaling is back scaling.

Pdcue_mode is defined as follows:

typedef enum {
PSUPPRESSED,
PALLOWED
} Pdcue_mode;

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;

Constants defined for colour type are:

0PINDIRECTIndirect
1PMODEL_RGBRed, Green, Blue
2PMODEL_CIELUVCIE
3PMODEL_HSVHue, Saturation, Value
4PMODEL_HLSHue, Lightness, Saturation

The index member of the val union is used for type PINDIRECT. The general member is used for the other types.

Execution

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

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

002Ignoring function, function requires state (PHOP,∗,∗,∗)

051Ignoring function, this information unavailable for this workstation type

052Ignoring function, workstation type not recognized by the implementation

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

062Ignoring function, this information is not available for this MO workstation type

102Ignoring function, specified representation has not been predefined on this workstation

603Ignoring function, depth cue index is less than zero

Museum