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

GPQMDS - Inquire Mapped Display Surface Size

GPQMDS (wsid, errind, units, csize, asize)

Note:

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

Purpose

Use GPQMDS to inquire the size of the mapped display surface on the specified workstation. The mapped display surface is the subarea of the window that the workstation uses as the workstation's display surface for graphical output and input. Only workstations which use the facilities of a window system (e.g., X-Windows) support this inquire.

The mapped display surface size may change if the user changes the size of the window that contains the mapped display surface. By enabling the Window Resize Notification function of the Escape (GPES) subroutine , your application can receive notification of such size changes. Then issue GPQMDS) to obtain the new size of the mapped display surface. In addition, your application can control the aspect ratio of the mapped display surface by using the Window Aspect Ratio (XWINDASP ) procopt.

If your application uses the GPDCMM subroutine and sets the method to 2=DIRECT , then the graPHIGS API returns the current size of the window, constrained to the same area as the root window. If the method is set to 1=MAPPED , then the graPHIGS API returns the size of the area that is used to display the device coordinate range, constrained to an area with the same aspect ratio as the root window, centered in the window.

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.

This subroutine is assigned escape identifier 1010.

Note:

This subroutine is an escape subroutine, and therefore, may not be available on all workstations. Use the Inquire List of Available Escape Subroutines (GPQES) subroutine to determine if this subroutine is supported by a specific workstation.

Parameters

wsid -- specified by user, fullword integer

Workstation 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:
25
SPECIFIED WORKSTATION DOES NOT EXIST
35
WORKSTATION HAS ONLY INPUT CAPABILITIES
527
ESCAPE FUNCTION NOT AVAILABLE

units -- returned by the graPHIGS API, fullword integer

Mapped display surface coordinate units (1=METERS, 2=OTHER )

csize -- returned by the graPHIGS API, 3 short floating-point numbers

Mapped display size surface in Device Coordinate (DC) units.

asize -- returned by the graPHIGS API, 3 fullword integers

Mapped display surface size in address units.

Error Codes

None

Related Subroutines

GPES
Escape

RCP code

201336853 (X'0C002815')


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