GINO Graphics Suite - GINO v9.0  

gEnqMaskState

Syntax

[C/C++:]
void gEnqMaskState(int *sw, GLIMIT *bounds);
[F90:]
subroutine gEnqMaskState(sw, bounds)

integer, intent(out) :: sw
type (GLIMIT), intent(out) :: bounds

Arguments

sw
State of masking switch

= 0, Masking off
= 1, Masking on, rectangular limits returned
= 2, Polygonal masking on, polygon rectangular boundary
returned

bounds
Mask bounds

Description

The routine gEnqMaskState() returns the current masking state.

If the mask has been defined using gSetMask2D(), the mask limits are returned in bounds. If a polygonal mask has been defined using gSetPolygonMask() this routine only returns the rectangular extent of the defined polygons. The list of polygon identifiers can be obtained using gEnqPolygonMaskList().

If no mask has been defined with gSetMask2D() or gSetPolygonMask(), the masking state will be returned as off, irrespective of the call to gSetMaskMode(), and all its bounds are returned as 0.0.

See Also

gEnqMaskState Usage
gSetMask2D
gSetPolygonMask
gEnqPolygonMaskList