[ Previous | Next | Contents | Glossary | Home | Search ]
The graPHIGS Programming Interface : Subroutine Reference

GPQCR - Inquire Color Representation

GPQCR (wsid, start, number, type, errind, colors)

Purpose

Use GPQCR to inquire the current color values in the specified workstation's default color table.

If the workstation's display color table is modifiable, then the display color table is the workstations's default. Otherwise the rendering color table is the workstation's default color table.

Use Inquire Extended Color Facilities (GPQXCF) subroutine to inquire the characteristics of the workstation's color table.

If the inquired information is available, then the graPHIGS API sets the error indicator to zero and returns the values in the output parameters. If the inquired information is unavailable, then the error indicator (errind) contains an error number indicating the reason, and the values returned in the output parameters are unpredictable.

Use Inquire Actual Length of Workstation Tables (GPQALW) subroutine to determine the actual size of the workstation's color table.

Parameters

wsid -- specified by user, fullword integer

Workstation identifier.

start -- specified by user, fullword integer

Index specifying an entry into the default color table to start returning the requested color values (>=0)

number -- specified by user, fullword integer

Number of color table entries requested (>=0)

type -- specified by user, fullword integer

Type of returned values (1=SET )

errind -- returned by the graPHIGS API, fullword integer

Error indicator. If the error indicator is zero, the request has been completed. Otherwise, one of the following errors exists:
25
SPECIFIED WORKSTATION DOES NOT EXIST
35
WORKSTATION HAS ONLY INPUT CAPABILITIES
534
TYPE VALUE IS INVALID
539
REQUESTED NUMBER < ZERO
544
START VALUE < ZERO
551
START VALUE EXCEEDS COLOR TABLE SIZE

colors -- returned by the graPHIGS API, array of three short floating-point numbers

Color components are to be interpreted by the current color model. The array contains a list of color table entries ordered by row. The output array must be large enough to contain the requested data.

Error Codes

None

Related Subroutines

GPCR
Set Color Representation
GPQXCR
Inquire Extended Color Representation

RCP code

201339137 (X'0C003101')


[ Previous | Next | Contents | Glossary | Home | Search ]