arch/include/joy.h

   1 /*
   2 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
   3 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
   4 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
   5 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
   6 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
   7 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
   8 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
   9 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
  10 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
  11 COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
  12 */
  13
  14 /*
  15  *
  16  * Header for joystick functions
  17  *
  18  */
  19
  20 #ifndef _JOY_H
  21 #define _JOY_H
  22
  23 #include "pstypes.h"
  24 #include "fix.h"
  25
  26 // added October 24, 2000 20:40  Steven Mueller: more than 4 joysticks now
  27 #define MAX_JOY_DEVS 8
  28 #define JOY_1_BUTTON_A  1
  29 #define JOY_1_BUTTON_B  2
  30 #define JOY_2_BUTTON_A  4
  31 #define JOY_2_BUTTON_B  8
  32 #define JOY_ALL_BUTTONS (1+2+4+8)
  33
  34 #define JOY_1_X_AXIS        1
  35 #define JOY_1_Y_AXIS        2
  36 #define JOY_1_Z_AXIS        4
  37 #define JOY_1_R_AXIS        16
  38 #define JOY_1_U_AXIS        32
  39 #define JOY_1_V_AXIS        64
  40
  41 #define JOY_MAX_AXES        32
  42
  43 #if defined WINDOWS
  44 #define JOY_NUM_AXES        7
  45 #elif defined USE_LINUX_JOY
  46 #define JOY_NUM_AXES        5
  47 #else
  48 #define JOY_NUM_AXES        4
  49 #endif
  50
  51 #ifdef WINDOWS
  52 #define JOY_1_POV           8
  53 #define JOY_ALL_AXIS        (1+2+4+8)
  54 #define JOY_EXT_AXIS        (16+32+64)
  55 #else
  56 #define JOY_2_X_AXIS        4
  57 #define JOY_2_Y_AXIS        8
  58 #define JOY_ALL_AXIS        (1+2+4+8)
  59 #endif
  60
  61 #define JOY_SLOW_READINGS       1
  62 #define JOY_POLLED_READINGS     2
  63 #define JOY_BIOS_READINGS       4
  64 /* not present in d2src, maybe we don't really need it? */
  65 #define JOY_FRIENDLY_READINGS   8
  66
  67 #ifdef USE_LINUX_JOY
  68 #define JOY_MAX_BUTTONS 64
  69 #else
  70 #define JOY_MAX_BUTTONS 20
  71 #endif
  72
  73 //==========================================================================
  74 // This initializes the joy and does a "quick" calibration which
  75 // assumes the stick is centered and sets the minimum value to 0 and
  76 // the maximum value to 2 times the centered reading. Returns 0 if no
  77 // joystick was detected, 1 if everything is ok.
  78 // joy_init() is called.
  79
  80 #ifdef WINDOWS
  81 # ifdef __NT__
  82 extern int joy_init(int joy, int spjoy);
  83 # endif
  84 extern int joy95_init_stick(int joy, int spjoy);
  85 #else
  86 extern int joy_init();
  87 #endif
  88 extern void joy_close();
  89
  90 extern char joy_installed;
  91 extern char joy_present;
  92
  93
  94 //==========================================================================
  95 // The actual number of available axes.  If the arch can't set this
  96 // properly, it should set joy_num_axes=JOY_NUM_AXES;
  97 extern int joy_num_axes;
  98
  99
 100 //==========================================================================
 101 // The following 3 routines can be used to zero in on better joy
 102 // calibration factors. To use them, ask the user to hold the stick
 103 // in either the upper left, lower right, or center and then have them
 104 // press a key or button and then call the appropriate one of these
 105 // routines, and it will read the stick and update the calibration factors.
 106 // Usually, assuming that the stick was centered when joy_init was
 107 // called, you really only need to call joy_set_lr, since the upper
 108 // left position is usually always 0,0 on most joys.  But, the safest
 109 // bet is to do all three, or let the user choose which ones to set.
 110
 111 extern void joy_set_ul();
 112 extern void joy_set_lr();
 113 extern void joy_set_cen();
 114
 115
 116 //==========================================================================
 117 // This reads the joystick. X and Y will be between -128 and 127.
 118 // Takes about 1 millisecond in the worst case when the stick
 119 // is in the lower right hand corner. Always returns 0,0 if no stick
 120 // is present.
 121
 122 extern void joy_get_pos(int *x, int *y);
 123
 124 //==========================================================================
 125 // This just reads the buttons and returns their status.  When bit 0
 126 // is 1, button 1 is pressed, when bit 1 is 1, button 2 is pressed.
 127 extern int joy_get_btns();
 128
 129 //==========================================================================
 130 // This returns the number of times a button went either down or up since
 131 // the last call to this function.
 132 extern int joy_get_button_up_cnt(int btn);
 133 extern int joy_get_button_down_cnt(int btn);
 134
 135 //==========================================================================
 136 // This returns how long (in approximate milliseconds) that each of the
 137 // buttons has been held down since the last call to this function.
 138 // It is the total time... say you pressed it down for 3 ticks, released
 139 // it, and held it down for 6 more ticks. The time returned would be 9.
 140 extern fix joy_get_button_down_time(int btn);
 141
 142 extern ubyte joy_read_raw_buttons();
 143 extern ubyte joystick_read_raw_axis(ubyte mask, int *axis);
 144 extern void joy_flush();
 145 extern ubyte joy_get_present_mask();
 146 extern void joy_set_timer_rate(int max_value);
 147 extern int joy_get_timer_rate();
 148
 149 extern int joy_get_button_state(int btn);
 150 extern void joy_set_cen_fake(int channel);
 151 extern ubyte joy_read_stick(ubyte masks, int *axis);
 152 extern void joy_get_cal_vals(int *axis_min, int *axis_center, int *axis_max);
 153 extern void joy_set_cal_vals(int *axis_min, int *axis_center, int *axis_max);
 154 extern void joy_set_btn_values(int btn, int state, fix timedown, int downcount, int upcount);
 155 extern int joy_get_scaled_reading(int raw, int axn);
 156 extern void joy_set_slow_reading(int flag);
 157
 158 #endif // _JOY_H