graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQPCR - Inquire Predefined Color Representation

GPQPCR (wstype, start, number, errind, npred, indexes, colors)

Note:

This subroutine is a Workstation Description Table (WDT) inquiry. For an overview, see "WDT Inquiries"

Purpose

Use GPQPCR to inquire the color values in the predefined color table entries in the default color table for the specified workstation. If you can modify the workstation's display color table, then the display color table is the workstation's default. Otherwise, the rendering color table is the workstation's default color table. Use the Inquire Extended Color Facilities (GPQXCF) subroutine to inquire the characteristics of the workstation's color table.

The graPHIGS API returns the predefined color components corresponding to the specified indexes. This data includes the total number of predefined color table entries (npred), the index of the color values (indexes), and the color components for those indexes (colors)

If the information is available, then the graPHIGS API sets the error indicator to zero and returns the values in the output parameter. If the error indicator is 543 (the start value exceeds the extent of the available data), then only the total number (totnum) parameter is set. If the inquired information is unavailable, then the error indicator (errind) contains the error number indicating the reason, and the values returned in the output parameter are unpredictable.

Parameters

wstype -- specified by user, 8-byte character string

Workstation type.

start -- specified by user, fullword integer

Starting member of the predefined default color table entries (>0)

number -- specified by user, fullword integer

Number of predefined default color table entries requested (>=0)

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:

23: SPECIFIED WORKSTATION TYPE DOES NOT EXIST
35: WORKSTATION HAS ONLY INPUT CAPABILITIES
538: START VALUE < ONE
539: REQUESTED NUMBER < ZERO
543: START EXCEEDS DATA EXTENT. TOTAL NUMBER AVAILABLE RETURNED
548: SPECIFIED WORKSTATION TYPE CANNOT BE LOADED

npred - returned by the graPHIGS API, fullword integer

Total number of predefined default color table entries.

indexes -- returned by the graPHIGS API, array of fullword integers

List of indexes of the predefined color representation. The output array must be large enough to contain the requested data.

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

Color components to be interpreted by the default color model. The array contains a list of color table entries ordered by row. Each entry in the list refers to the corresponding index in the indexes array. The output array must be large enough to contain the requested data.

Error Codes

None

Related Subroutines

GPQRCT: Inquire Realized Connection Type

RCP code

201339905 (X'0C003401')