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.13  vq_mouse                                                   TOS

 Name:         »Sample mouse button state« - Obtain position and 
               status of the mouse buttons.

 Opcode:       124

 Syntax:       void vq_mouse ( int16_t handle, int16_t *pstatus, 
               int16_t *x, int16_t *y );

 Description:  The call vq_mouse obtains the current cursor position 
               and the current status of the mouse buttons. The 
               following apply:

                Parameter  Meaning

                handle     Workstation identifier
                pstatus    Mouse button state
                            Bit-0 = Left mouse button
                            Bit-1 = Right mouse button (etc.)
                x          X-position of cursor
                y          Y-position of cursor

               In GEM programs one should use the AES function 
               graf_mkstate to ensure that only the information about 
               the position and state of the mouse buttons intended 
               for one's own application is obtained.

               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_mkstate or the event functions instead.

 Return value: The function does not return a result.

 Availability: Supported by all screen drivers.

 Group:        Input functions

 See Also:     Binding   graf_mkstate