Topic       : TOS - The Operating System
Author      : 
Version     : tos.hyp (December 19, 2008)
Subject     : Programmieren/Atari
Nodes       : 3010
Index Size  : 93790
HCP-Version : 5
Compiled on : Atari
@charset    : atarist
@lang       : 
@default    : Title
@help       : 
@options    : +g -i -s +x +zz -t4
@width      : 70
View Ref-File7.10.43  vs_clip                                                   TOS

 Name:         »Set clipping rectangle«

 Opcode:       129

 Syntax:       void vs_clip ( int16_t handle, int16_t clip_flag, 
               int16_t *pxyarray );

 Description:  The call vs_clip limits all graphical output to a given 
               region. The following apply:

                Parameter    Meaning

                handle       Workstation identifier
                clip_flag
                              0 =     Clipping off
                              1 =     Clipping on
                pxyarray[0]  X-coordinate, and
                pxyarray[1]  Y-coordinate of a rectangle corner point
                pxyarray[2]  X-coordinate, and
                pxyarray[3]  Y-coordinate of the diagonally opposite 
                             corner point

               Note: Do not switch off clipping, because a graphic 
               object which is drawn outside of the visible screen 
               area will overwrite memory or cause a bus error.

               If the working area is to include the complete screen, 
               it is advisable to set the screen dimensions for 
               vs_clip obtained from v_opnvwk.

 Return value: The function does not return a result.

 Availability: Supported by all drivers.

 Group:        Control functions

 See Also:     Binding   Clipping