gpr_set_mult_clip_window() — Apollo Domain/OS SR10.3.5

GPR_$SET_MULT_CLIP_WINDOW         GPR Calls          GPR_$SET_MULT_CLIP_WINDOW


NAME
     gpr_$set_mult_clip_window - sets multiple clip windows for the current
     attribute block and bitmap.

FORMAT
     gpr_$set_mult_clip_window (clip_list, n_clip_list, n_multiple_clips_used,
                                status)

DESCRIPTION
     This routine sets the clip window(s) of the current attribute block and
     bitmap.

   Input Parameters
     clip_list
          The list of clip windows, in gpr_$window_list_t format.

     n_clip_list
          The number of clip windows in the clip list.  This is a 2-byte
          integer.

   Output Parameters
     n_multiple_clips_used
          The number of clip windows used.  This is a 2-byte integer.

     status
          Completion status, in status_$t format.

NOTES
     This call is the equivalent of gpr_$set_clip_window for devices support-
     ing multiple clip windows.

     Multiple clip windows are only available on the Series 10000VS.

     This call also works on devices that do not support multiple clip win-
     dows.  In these cases, gpr_$set_mult_clip_window has the same functional-
     ity as gpr_$set_clip_window.

     To request the dimensions of the active clip windows, call
     gpr_$inq_mult_constraints.

     To get the list of the visible rectangles of an obscured window, call
     gpr_$inq_vis_list.  You should not enlarge any rectangle in the list
     before calling gpr_$set_mult_clip_window.

     The n_mult_clips field of the display characteristics specifies the max-
     imum number of clip windows you can set at one time on a device.  Call
     gpr_$inq_display_characteristics or gpr_$inq_disp_characteristics to get
     the display characteristics.

     The default clip window is the entire bitmap.  To enable the new clip
     windows, call gpr_$set_clipping_active.

     Pixels outside the clip windows are not modified by subsequent opera-
     tions.
Museum
