graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQIBC - Inquire Image Board Characteristics

GPQIBC (ibid, errind, depth, h, v)

Note:

This subroutine is a graPHIGS API State List (PSL) inquiry. For an overview, see "PSL Inquiries"

Purpose

Use GPQIBC to inquire the image board characteristics for the specified image board: the image board was created by the Create Image Board (GPCRIB) subroutine.

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.

Parameters

ibid -- specified by user, fullword integer

Image board identifier.

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:

232: SPECIFIED IMAGE BOARD DOES NOT EXIST

depth -- returned by the graPHIGS API, fullword integer

Bit depth of the image board.

h -- returned by the graPHIGS API, fullword integer

Horizontal size of the image board.

v -- returned by the graPHIGS API, fullword integer

Vertical size of the image board.

Error Codes

None

Related Subroutines

GPCRIB: Create Image Board
GPFRCT: Fill Rectangle
GPRDFB: Read Frame Buffer
GPQIBF: Inquire Image Board Facilities
GPWRCT: Write Rectangle

RCP code

201345800 (X'0C004B08')