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

NAME

INQUIRE PREDEFINED EDGE REPRESENTATION PLUS − inquire a predefined extended edge representation for a specified workstation type

SYNOPSIS

C Syntax

void
pinq_pred_edge_rep_plus ( type, index, error_ind, bundle )
Pinttype;workstation type
Pintindex;predefined index
Pint∗error_ind;OUT error indicator
Pedge_bundle_plus∗bundle; OUT predefined edge rep

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE PREDEFINED EDGE REPRESENTATION PLUS returns the attribute values of a specified predefined entry in the extended edge bundle table of a workstation type’s workstation description table. See SET EDGE REPRESENTATION PLUS for a full description of the contents of the bundle table entry and a description of the extended edge bundle 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.

bundle
A pointer to a Pedge_bundle_plus structure that returns the requested representation. Pedge_bundle_plus is defined as:

typedef struct {
Pedge_flagflag;/∗ edge flag ∗/
Pinttype;/∗ edgetype ∗/
Pfloatscale;/∗ edgewidth scale factor ∗/
Pgcolrcolr;/∗ edge colour ∗/
} Pedge_bundle_plus;

Valid values for the Pedge_flag enumerated type are defined in phigs.h as:

typedef enum {
PEDGE_OFF,
PEDGE_ON
} Pedge_flag;

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 below 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

100Ignoring function, the bundle index value is less than one

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

Museum