graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQLSF - Inquire Light Source Facilities

GPQLSF (wstype, start, number, errind, maxe, totnum, ltype, maxa, npred)

Note:

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

Purpose

Use GPQLSF to inquire the light source facilities for the specified workstation.

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 list of available light source types (>=1)

number -- specified by user, fullword integer

Number of light source type 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

maxe -- returned by the graPHIGS API, fullword integer

Maximum number of light source table entries.

totnum -- returned by the graPHIGS API, fullword integer

Total number of available light source types supported on the workstation.

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

List of light source types (1=AMBIENT, 2=DIRECTIONAL, 3=POSITIONAL, 4=SPOT )

maxa -- returned by the graPHIGS API, fullword integer

Maximum number of simultaneously active non-ambient light sources.

npred -- returned by the graPHIGS API, fullword integer

Number of predefined light source indexes.

Error Codes

None

Related Subroutines

GPLSR: Set Light Source Representation
GPQLSR: Inquire Light Source Representation
GPQRCT: Inquire Realized Connection Type

RCP code

201346052 (X'0C004C04')