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

GPQWDT - Inquire Workstation Description

GPQWDT (wstype, id, lidata, idata, mlodata, errind, lodata, odata)

Note:

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

Purpose

Use GPQWDT to inquire particular information from the Workstation Description Table for the specified workstation. The id parameter identifies the data that the graPHIGS API returns. Some data types may require additional information in the idata parameter.

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 inquired information is unavailable, then the error indicator (errind) contains the error number indicating the reason, and the values returned in the output parameters are unpredictable.

The mlodata parameter specifies the length of the odata output parameter. In general, the length of the odata output area must be a certain minimum length. See the parameter descriptions for the required mimimum lengths.

Parameters

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

Workstation type.

id -- specified by user, fullword integer

Group identifier. The following identifiers are supported:

1:
Modeling Clipping Facilities

2:
Transparency Facilities

3:
Data Mapping Facilities

4:
Text Encoding Facilities

5:
Morphing Facilities

lidata -- specified by user, fullword integer

Length in bytes of input data area (>= 0).

idata -- specified by user, variable-length data

Input data. Depending on the id parameter value specified, input data is as follows:

1 = Modeling Clipping Facilities
N/A (none required for this type)

2 = Transparency Facilities
N/A (none required for this type)

3 = Data Mapping Facilities
N/A (none required for this type)

4 = Text Encoding Facilities
N/A (none required for this type)

5 = Morphing Facilities
N/A (none required for this type)

mlodata -- specified by user, fullword integer

Length in bytes of output data area. Depending on the id parameter value specified, the minimum length value is as follows:

1 = Modeling Clipping Facilities
Minimum length value = 8

2 = Transparency Facilities
Minimum length value = 16

3 = Data Mapping Facilities
Minimum length value = 12

4 = Text Encoding Facilities
Minimum length value = 4

5 = Morphing Facilities
Minimum length value = 4

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
FUNCTION REQUIRES STATE STOP OR NROP (NOT STCL)

272
GROUP IDENTIFIER IS INVALID

509
DATA LENGTH VALUE < ZERO OR REQUIRED LENGTH

533
INQUIRY DATA EXCEEDS AREA. OUTPUT TRUNCATED

548
SPECIFIED WORKSTATION TYPE CANNOT BE LOADED

lodata -- returned by the graPHIGS API, fullword integer

Length of available output data, in bytes.

odata -- returned by the graPHIGS API, Variable-length data

Output data. Depending on the id parameter value specified, output data is as follows:

1 = Modeling Clipping Facilities
The following data is returned: 
                    ---------------------
     WORDS 1        |      'maxhs'      |  Fullword integer
                    |-------------------|
           2        |      'noper'      |  Fullword integer
                    |-------------------|
           3n       |      'loper'      |     noper *
                    Z                   Z   Fullword integer
                    |                   |
                    ---------------------

maxhs
Maximum number of clipping half-spaces.

noper
Number of available modeling clipping operators.

loper
List of available modeling clipping operators (1=REPLACE_VOLUME, 2=INTERSECT_VOLUME ).

2 = Transparency Facilities
The following data is returned: 
                    ---------------------
     WORDS 1        |      'alphab'     |  Fullword integer
                    |-------------------|
           2        |       'nptl'      |  Fullword integer
                    |-------------------|
           3        |      'nsrcf'      |  Fullword integer
                    |-------------------|
           4        |      'ndestf'     |  Fullword integer
                    |-------------------|
           5  n     |      'lsrcf'      |  nsrcf * Fullword integer
                    |-------------------|
           n  m     |      'ldestf'     |  ndestf * Fullword integer
                    ---------------------

alphab

Availability of alpha buffer (1=NO, 2=YES ).

nptl

Number of partial transparency levels supported.

nsrcf

Number of source blending functions.

ndestf

Number of destination blending functions.

lsrcf

List of source blending functions (1=SRCBF_ZERO, 2=SRCBF_ONE, 3=SRCBF_SRC_ALPHA, 4=SRCBF_ONE_MINUS_SRC_ALPHA, 5=SRCBF_DST_ALPHA, 6=SRCBF_ONE_MINUS_DST_ALPHA, 7=SRCBF_DST_COLOR, 8=SRCBF_ONE_MINUS_DST_COLOR, 9=SRCBF_MIN_SRC_ALPHA_ONE_MINUS_DST_ALPHA ).

ldestf

List of destination blending functions (1=DSTBF_ZERO, 2=DSTBF_ONE, 3=DSTBF_SRC_ALPHA, 4=DSTBF_ONE_MINUS_SRC_ALPHA, 5=DSTBF_DST_ALPHA, 6=DSTBF_ONE_MINUS_DST_ALPHA, 7=DSTBF_SRC_COLOR, 8=DSTBF_ONE_MINUS_SRC_COLOR ).

3 = Data Mapping Facilities
The following data is returned: 
                    ---------------------
     WORDS 1        |      'ndmrep'     |  Fullword integer
                    |-------------------|
           2        |      'ndatam'     |  Fullword integer
                    |-------------------|
           3        |      'nctypes'    |  Fullword integer
                    |-------------------|
           4  n     |      'ldatam'     |    ndatam *
                    |                   |  Fullword integer
                    |-------------------|
           n  m     |      'lctypes'    |    nctypes *
                    |                   |  Fullword integer
                    ---------------------

ndmrep

Number of definable data mapping table entries. Entry 0 of the data mapping table may not be changed.

ndatam

Number of available data mapping methods.

nctypes

Number of available data mapping color data types.

ldatam

List of available data mapping methods (-1=IMAGE_ARRAY, 1=DM_METHOD_COLOR, 2=SINGLE_VALUE_UNIFORM, 4=BI_VALUE_UNIFORM ).

lctypes

List of available data mapping color data types (1=TYPE_COLOR, 2=TYPE_PACKED_RGB, 3=TYPE_COLOR_TRANS, 4=TYPE_PACKED_RGB_ALPHA ).

4 = Text Encoding Facilities
The following data is returned: 
                    ---------------------
     WORDS 1        |      'nencodm'    |  Fullword integer
                    |-------------------|
           3  n     |      'lencodm'    |    nencodm *
                    |                   |  Fullword integer
                    ---------------------

nencodm

Number of available text encoding methods.

lencodm

List of available text encoding methods (1=UNICODE ).

5 = Morphing Facilities
The following data is returned: 
                    ---------------------
     WORDS 1        |      'nmorphv'    |  Fullword integer
                    ---------------------

nmorphv

Maximum number of morphing vectors supported.

Error Codes

None

RCP code

201346065 (X'0C004C11')

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