git.sur5r.net Git - cc65/blob - include/mouse.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                  mouse.h                                  */
   4 /*                                                                           */
   5 /*                                 Mouse API                                 */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1999-2000 Ullrich von Bassewitz                                       */
  10 /*               Wacholderweg 14                                             */
  11 /*               D-70597 Stuttgart                                           */
  12 /* EMail:        uz@musoftware.de                                            */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef _MOUSE_H
  37 #define _MOUSE_H
  38
  39
  40
  41 /* Define __MOUSE__ for systems that support a mouse */
  42 #ifdef __C64__
  43 #  define __MOUSE__
  44 #endif
  45 #ifdef __C128__
  46 #  define __MOUSE__
  47 #endif
  48 #ifdef __ATARI__
  49 #  define __MOUSE__
  50 #endif
  51
  52
  53 /*****************************************************************************/
  54 /*                                Definitions                                */
  55 /*****************************************************************************/
  56
  57
  58 /* the different mouse types */
  59 #define MOUSE_TRAKBALL 0
  60 #define MOUSE_ST       1
  61 #define MOUSE_AMIGA    2
  62 #define MOUSE_C64      3      /* 1351 mouse */
  63
  64
  65
  66 /*****************************************************************************/
  67 /*                                 Functions                                 */
  68 /*****************************************************************************/
  69
  70
  71
  72 void __fastcall__ mouse_init (unsigned char port, unsigned char sprite, unsigned char type);
  73 /* Setup the mouse interrupt handler. If the sprite value is != zero, the
  74  * mouse routines will manage the sprite with this number. That means, it
  75  * is moved if the mouse is moved (provided that the mouse cursor is visible),
  76  * and switched on and off in the show and hide functions.
  77  * The port parameter gives the joystick port used for the mouse and is only
  78  * needed to read the mouse button state.
  79  * The type parameter is needed on some systems to determine the type of
  80  * the mouse connected to the given port.
  81  * After calling this function, the mouse is invisble, the cursor is placed
  82  * at 0/0 (upper left corner), and the bounding box is reset to cover the
  83  * whole screen. Call mouse_show once to make the mouse cursor visible.
  84  */
  85
  86 void mouse_done (void);
  87 /* Disable the mouse, remove the interrupt handler. This function MUST be
  88  * called before terminating the program, otherwise odd things may happen.
  89  * If in doubt, install an exit handler (using atexit) that calls this
  90  * function.
  91  */
  92
  93 void mouse_hide (void);
  94 /* Hide the mouse. This function doesn't do anything visible if no sprite is
  95  * used. The function manages a counter and may be called more than once.
  96  * For each call to mouse_hide there must be a call to mouse_show to make
  97  * the mouse visible again.
  98  */
  99
 100 void mouse_show (void);
 101 /* Show the mouse. This function doesn't do anything visible if no sprite is
 102  * used. See mouse_hide for more information.
 103  */
 104
 105 void __fastcall__ mouse_box (int minx, int miny, int maxx, int maxy);
 106 /* Set the bounding box for the mouse pointer movement. The mouse X and Y
 107  * coordinates will never go outside the given box.
 108  * NOTE: The function does *not* check if the mouse is currently inside the
 109  * given margins. The proper way to use this function therefore is:
 110  *
 111  *      - Hide the mouse
 112  *      - Set the bounding box
 113  *      - Place the mouse at the desired position
 114  *      - Show the mouse again.
 115  *
 116  * NOTE2: When setting the box to something that is larger than the actual
 117  * screen, the positioning of the mouse cursor will fail. If such margins
 118  * are really what you want, you have to use your own cursor routines.
 119  */
 120
 121 void __fastcall__ mouse_move (int x, int y);
 122 /* Set the mouse cursor to the given position. If a mouse cursor is defined
 123  * and currently visible, the mouse cursor is also moved.
 124  * NOTE: This function does not check if the given position is valid and
 125  * inside the bounding box.
 126  */
 127
 128 unsigned char mouse_down(void);
 129 /* Get mouse button state (0 - up, 1 - dowm)
 130  */
 131
 132 void mouse_info (void);
 133 /* Hmmm...
 134  */
 135
 136
 137 /* End of mouse.h */
 138 #endif
 139