graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQDCR - Inquire Depth Cue Representation

GPQDCR (wsid, index, type, number, ids, errind, data)

Note:

This subroutine is a Workstation State List (WSL) inquiry. For an overview, see "WSL Inquiries"

Purpose

Use GPQDCR to inquire the current value of one or more fields in the specified depth cue table entry of the specified workstation's depth cue table. Each field is identified by a group identifier.

If the inquired information is available, then the graPHIGS API sets the error indicator to zero and returns the values in the output parameter in the requested order. The output parameter must be large enough to store all requested data.

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.

Parameters

wsid -- specified by user, fullword integer

Workstation identifier.

index -- specified by user, fullword integer

Depth cue table index (>=0)

type -- specified by user, fullword integer

Type of returned value (1=SET )

number -- specified by user, fullword integer

Number of group identifiers requested (>=1)

ids -- specified by user, array of fullword integers

A list of group identifiers

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
261: DEPTH CUE INDEX < ZERO
262: DEPTH CUE INDEX EXCEEDS THE WORKSTATION TABLE CAPACITY
272: GROUP IDENTIFIER IS INVALID
273: NUMBER OF GROUP IDENTIFIERS < ONE
534: TYPE VALUE IS INVALID

data -- returned by the graPHIGS API, variable data.

Data array containing the values in the requested groups. The value of each field is expressed in the data format listed below:

Group identifier 1 - Depth cue mode

A fullword integer (1=SUPPRESSED, 2=ALLOWED )

Group identifier 2 - Depth cue reference planes

Two short floating-point numbers specifying the far and near depth cue reference plane distance.

Group identifier 3 - Depth cue scale factors

Two short floating-point numbers specifying two scale factors corresponding to the far and near reference planes.

Group identifier 4 - Depth cue color

Four fullwords of data with either of the following two formats:

      indexed format                        direct format
      -------------                         -------------
    0 |          1| fullword integer      0 |          2| fullword integer
      |-----------|                         |-----------|   
    4 |color index| fullword integer      4 |component 1| short floating-point number
      |-----------|                         |-----------|      
    8 |    ignored| fullword integer      8 |component 2| short floating-point number
      |-----------|                         |-----------|      
   12 |    ignored| fullword integer     12 |component 3| short floating-point number
      -------------                         -------------

Error Codes

None

Related Subroutines

GPDCI: Set Depth Cue Index
GPDCR: Set Depth Cue Representation
GPQDCF: Inquire Depth Cue Facilities

RCP code

201339148 (X'0C00310C')