INQUIRE DISPLAY SPACE SIZE 3(3P) — SUNPHIGS LIBRARY

NAME

INQUIRE DISPLAY SPACE SIZE 3− inquire the display space size of a workstation type.

SYNOPSIS

C Syntax

void
pinqdisplayspacesize3 ( type, error_ind, size )
Pwstypetype;workstation type
Pint∗error_ind;OUT error indicator
Pdspsize3∗size;OUT display size

FORTRAN Syntax

SUBROUTINE pqdsp3 ( WTYPE, ERRIND, DCUNIT, DX, DY, DZ, RX, RY, RZ )
INTEGERWTYPEworkstation type
INTEGERERRINDOUT error indicator
INTEGERDCUNITOUT device coordinate units (PMETRE, POTHU)
REALDX, DY, DZOUT maximum display surface size (DC)
INTEGERRX, RY, RZOUT maximum display surface size (raster units)

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE DISPLAY SPACE SIZE 3 returns the display space size associated with the workstation type specified. Both virtual and real sizes are returned. The workstation type passed as an argument to this function can be either a generic type or a specific type, a specific type being one associated with an open workstation and obtained by a call to INQUIRE WORKSTATION CONNECTION AND TYPE. The information is retrieved from the workstation description table associated with the workstation type.

C Input Parameters

typeThe workstation type, either generic or specific.

error_ind
The error indicator. See the Execution section below for a description of its use. See the Errors section below for the possible values it may return.

sizeA pointer to a Pdspsize3 structure in which to store the requested information. Pdspsize3 is defined in phigs.h as:

typedef struct {
Pdevunitsunits;/∗ device coordinate units ∗/
Ppoint3device;/∗ device volume in coordinate units ∗/
Pipoint3raster;/∗ addressable units ∗/
} Pdspsize3;

units indicates the unit type, if any, of the device coordinate units.
Pdevunits is defined in phigs.h as:

typedef enum {
PDC_METERS,
PDC_OTHER
} Pdevunits;

device contains the upper limits of the device coordinate units. The lower limits are zero in all dimensions. See the Execution section below for a description of the meaning of these values.

raster contains the number of addressable units corresponding to the device coordinate units. See the Execution section below for a description of the meaning of these values for each supported workstation type.

FORTRAN Input Parameters

WTYPE
The workstation type, either generic or specific.

ERRIND
The error indicator. See the Execution section below for a description of its use. See the Errors section below for the possible values it may return.

DCUNIT
The unit type, if any, of the device coordinate units. Valid values as defined in phigs77.h are:

PMETRE(meters),
POTHU(other)

DX, DY, DZ
The upper limits of the device coordinate units. The lower limits are zero in all dimensions. See the Execution section below for a description of the meaning of these values.

RX, RY, RZ
The number of addressable units corresponding to the device coordinate units. See the Execution section below for a description of the meaning of these values for each workstation type.

Execution

INQUIRE DISPLAY SPACE SIZE 3 retrieves the device coordinate space limits and the number of addressable units of a workstation type. The device coordinate space limits correspond to the maximun device coordinate (DC) values of a workstation type. DC is the conceptual coordinate system of the display device and is the coordinate system used by the application to specify the workstation viewport and input device echo areas. The lower limits of DC are always zero in all three dimensions.

The DC limits and addressable units are specified in the workstation description table associated with a workstation type. The DC limits can be changed prior to opening a workstation but become fixed once a workstation is opened. See WORKSTATION TYPE SET for a description of how to change the DC limits prior to opening a workstation. The DC limits can be different in all three dimensions.

The meaning of the addressable units depends both on the workstaion type and its status:

Sun Tool and Sun Canvas types
If the type specified is a specific workstation type, i.e., one associated with an open workstation, then the x and y addressable units correspond to the size, in pixels, of the portion of the graphics window actually being used. The portion being used, called the active area, is the largest portion that conforms to the aspect ratio of the DC limits, e.g., if the DC limits are the same in x and y then the active area is the largest square portion of the window that can be used. The active area is always lower-left justified in the graphics window of the workstation. If the workstation type is a specific type and the workstation associated with it has a depth buffer available to it, then the z dimension of the addressable limits corresponds to the depth of the depth buffer; otherwise the z dimension is 1.

The addressable units of a specific workstation type will change if the operator changes the size of the workstation via window system actions. Subsequent calls to INQUIRE DISPLAY SPACE SIZE 3 will reflect this change by returning the addressable units in effect at the time of the function call. The DC limits will never change for an open workstation. Thus, since only DC units are ever passed to PHIGS functions, the application need not concern itself with window size changes. SunPHIGS will automatically rescale the output to the new window size and use the largest portion of the window that corresponds to the implied aspect ratio.

If the type specified is a generic Sun Tool workstation type, i.e., one not associated with an open workstation, then the addressable limits correspond to the size, in pixels, of the portion of the graphics window that would be used if a workstation were opened with that type.

If the type specified is a generic Sun Canvas workstation type, then error 51 will be returned in the error indicator, indicating that the information is unavailable for such a workstation type and a specific workstation type is required.

CGM output types
The addressable limits are fixed at 32767 in the x and y dimensions and 1 in the z dimension.

If an error is detected by this function the error indicator will indicate the error number of the error detected and no other output data will be returned. If no error is detected, the error indicator will be set to zero and the inquired information will be available in the output parameters. Since this is an inquiry function, ERROR HANDLING is not invoked when an error is detected by this function.

ERRORS

002Ignoring function, function requires state (PHOP, ∗, ∗, ∗)

052Ignoring function, workstation type not recognized by the implementation

051Ignoring function, this information is not yet available for this workstation type; open a workstation of this type and use the specific workstation type

057Ignoring function, specified workstation is of category MI

062Ignoring function, this information is not available for this MO workstation type

Museum