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.7.23  vsc_form                                                   TOS

 Name:         »Set mouse form« - Set the mouse pointer shape.

 Opcode:       111

 Syntax:       void vsc_form ( int16_t handle, int16_t *pcur_form );

 Description:  The call vsc_form permits the definition of the shape 
               of the mouse pointer, which is stored in the MFORM 
               structure. The following apply:

                Parameter          Meaning

                handle             Workstation identifier
                pcur_form[0]       X-coordinate, and
                pcur_form[1]       Y-coordinate of hot-spot
                pcur_form[2]       Number of planes, must be 1
                pcur_form[3]       Colour index of background mask 
                                   (should be 0)
                pcur_form[4]       Colour index of foreground mask 
                                   (should be 1)
                pcur_form[05..20]  Definition of background mask
                pcur_form[21..36]  Definition of foreground mask

               Each mask is dimensioned as a 16-WORD field each of 16 
               bits. Bit 15 of the first WORD is here the top left 
               corner of the mask, and bit 0 of WORD 16 is the bottom 
               right corner.

               Under hot-spot one understands the exact position of 
               the active part of the graphic cursor. With an arrow 
               this corresponds to the arrow's tip, with a cross it is 
               the crossing-point. The coordinates are specified 
               relative to the top left corner of the mask.

               For setting the mouse pointer shape, all GEM programs 
               should use the AES function graf_mouse. Otherwise the 
               mouse pointer shape management of the AES will become 
               permanently confused.

               Note: The input functions of the VDI work only on the 
               physical workstation, which is normally used by the 
               AES. Therefore it is better to fall back to using 
               graf_mouse instead.

               Under NVDI it is also possible to obtain the current 
               shape of the mouse pointer (see Binding).

 Return value: The function does not return a result.

 Availability: Supported by all screen drivers.

 Group:        Input functions

 See Also:     Binding   graf_mouse   MFORM