GPR_$SET_CLIPPING_ACTIVE          GPR Calls           GPR_$SET_CLIPPING_ACTIVE


NAME
     gpr_$set_clipping_active - enables/disables a clipping window.

FORMAT
     gpr_$set_clipping_active (active, status)

DESCRIPTION
     This routine enables/disables a clipping window for the current bitmap.

     Initially, in borrow mode, the clip window is disabled.  In direct mode,
     the clip window is enabled and clipped to the size of the window.  Clip-
     ping cannot be enabled in a bitmap corresponding to a Display Manager
     frame.

   Input Parameters
     active
          A Boolean (logical) value which specifies whether or not to enable
          the clipping window.  Set this value to true to enable the clipping
          window; set it to false to disable the clipping window.

   Output Parameters
     status
          Completion status, in status_$t format.

SEE ALSO
     gpr_$set_clip_window, gpr_$inq_constraints.

NOTES
     To specify a clipping window, use the routine gpr_$set_clip_window.

     To inquire whether the clip window is enabled, use gpr_$inq_constraints.