GPR_$SET_CLIP_WINDOW              GPR Calls               GPR_$SET_CLIP_WINDOW


NAME
     gpr_$set_clip_window - changes the clipping window.

FORMAT
     gpr_$set_clip_window (window, status)

DESCRIPTION
     This routine changes the clipping window for the current bitmap.

     The default clip window is the entire bitmap.  Use the
     gpr_$set_clip_window to set a nondefault clip window.  Note that the clip
     window does not become activated until you call gpr_$set_clipping_active.

     In direct mode, the clip window and coordinate origin are relative to the
     the upper left-hand corner of the window.

     A clip window cannot be made larger than the dimensions specified for a
     bitmap.  For applications that run in windows that are dynamically
     enlarged, specify the size parameter of gpr_$init to be the size of the
     display. In this way, the clip rectangle will automatically be enlarged
     with the window whenever the window is enlarged.

     Pixels outside the clip window in the current bitmap are not modified by
     subsequent operations.

   Input Parameters
     window
          The new clipping window, in gpr_$window_t format.  This data type is
          8 bytes long.

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

SEE ALSO
     gpr_$inq_constraints.

NOTES
     To  request  the   dimensions   of   the   current   clip   window,   use
     gpr_$inq_constraints.

     This call is not allowed on  the  bitmap  corresponding  to  the  Display
     Manager frame.