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

NAME

INQUIRE PREDEFINED PATTERN REPRESENTATION PLUS − inquire a predefined extended pattern representation for a specified workstation type

SYNOPSIS

C Syntax

void
pinq_pred_pat_rep_plus ( type, index, store, error_ind, rep )
Pinttype;workstation type
Pintindex;predefined index
Pstorestore;handle to Store object
Pint∗error_ind;OUT error indicator
Ppat_rep_plus∗∗rep;OUT predefined pattern rep

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE PREDEFINED PATTERN REPRESENTATION PLUS inquires a predefined extended pattern representation for a specified workstation type.

C Input Parameters

Applications using the C binding must create a buffer to be used by this function as memory space for storing data associated with the device state. This buffer is passed as the store argument.

The store buffer is a data area managed by PHIGS. While the application is responsible for creating the inital buffer through a call to CREATE STORE, PHIGS manages this area such that there is sufficient memory for the specific inquiry. The data record within the store buffer is accessed by the pointer pointed to by rep.

typeThe workstation type.

indexIndex of the predefined entry to be returned.

storeThe memory buffer PHIGS is to use for storing the information returned. This buffer must exist prior to calling this function (see CREATE STORE (3P)).

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 pointer to a Ppat_rep_plus structure that returns the requested representation. Ppat_rep_plus is defined in phigs.h as follows:

typedef struct {
Pint_sizedims;/∗ pattern’s dimensions ∗/
Pinttype;/∗ colour type ∗/
Pcoval∗colr_array;/∗ array of colours ∗/
} Ppat_rep_plus;

Pint_size is definied in phigs.h as follows:

typedef struct {
Pintsize_x;
Pintsize_y;
} Pint_size;

Pcoval is definied in phigs.h as follows:

typedef union {
Pintind;/∗ index in workstation colour bundle table ∗/
Pcolr_repdirect;/∗ direct colour components ∗/
} Pcoval;

Pcolr_rep is defined in phigs.h as follows:

typedef union {
Prgbrgb;/∗ Red Green Blue colour specification ∗/
Pcieluvcieluv;/∗ CIE L∗U∗V∗ colour specification ∗/
Phlshls;/∗ Hue Lightness Saturation colour specification ∗/
Phsvhsv;/∗ Hue Saturation Value colour specification ∗/
Pdataunsupp;/∗ Colour in unsupported colour model ∗/
} Pcolr_rep;

Prgb is defined in phigs.h as follows:

typedef struct {
Pfloatred;/∗ red, hue, etc ∗/
Pfloatgreen;/∗ green, saturation, lightness, etc ∗/
Pfloatblue;/∗ blue, value, saturation, etc ∗/
} Prgb;

Pcieluv is defined in phigs.h as follows:

typedef struct {
Pfloatcieluv_x;/∗ x coefficient ∗/
Pfloatcieluv_y;/∗ y coefficient ∗/
Pfloatcieluv_y_lum; /∗ y luminance ∗/
} Pcieluv;

Phsv is defined in phigs.h as follows:

typedef struct {
Pfloathue;/∗ hue ∗/
Pfloatsatur;/∗ saturation ∗/
Pfloatvalue;/∗ value ∗/
} Phsv;

Phls is defined in phigs.h as follows:

typedef struct {
Pfloathue;/∗ hue ∗/
Pfloatlightness;/∗ lightness ∗/
Pfloatsatur;/∗ saturation ∗/
} Phls;

Pdata is defined in phigs.h as follows:

typedef struct {
size_tsize;/∗ size of data ∗/
char∗data/∗pointer to data ∗/
} Pdata;

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

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

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

Museum