More header unification...
[btb/d2x.git] / 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  * $Source: /cvs/cvsroot/d2x/arch/include/joy.h,v $
16  * $Revision: 1.1 $
17  * $Author: bradleyb $
18  * $Date: 2001-01-28 16:10:57 $
19  *
20  * Header for joystick functions
21  *
22  * $Log: not supported by cvs2svn $
23  */
24
25 #ifndef _JOY_H
26 #define _JOY_H
27
28 #include "pstypes.h"
29 #include "fix.h"
30
31 #define JOY_1_BUTTON_A  1
32 #define JOY_1_BUTTON_B  2
33 #define JOY_2_BUTTON_A  4
34 #define JOY_2_BUTTON_B  8
35 #define JOY_ALL_BUTTONS (1+2+4+8)
36
37 #define JOY_1_X_AXIS            1
38 #define JOY_1_Y_AXIS            2
39 #define JOY_1_Z_AXIS            4
40 #define JOY_1_R_AXIS            16
41 #define JOY_1_U_AXIS            32
42 #define JOY_1_V_AXIS            64
43
44 #if defined WINDOWS
45 #define JOY_NUM_AXES            7
46 #elif defined __ENV_LINUX__
47 #define MAX_AXES                32
48 #define JOY_NUM_AXES            5
49 #else
50 #define JOY_NUM_AXES            4
51 #endif
52
53 #ifdef  _WIN32
54 #define JOY_1_POV                       8
55 #define JOY_ALL_AXIS            (1+2+4+8)
56 #define JOY_EXT_AXIS            (16+32+64)
57 #else
58 #define JOY_2_X_AXIS            4
59 #define JOY_2_Y_AXIS            8
60 #define JOY_ALL_AXIS            (1+2+4+8)
61 #endif
62
63 #define JOY_SLOW_READINGS       1
64 #define JOY_POLLED_READINGS     2
65 #define JOY_BIOS_READINGS       4
66 /* not present in d2src, maybe we don't really need it? */
67 #define JOY_FRIENDLY_READINGS   8
68
69 #ifdef __ENV_LINUX__
70 #define MAX_BUTTONS 64
71 #else
72 #define MAX_BUTTONS 20
73 #endif
74
75 //==========================================================================
76 // This initializes the joy and does a "quick" calibration which
77 // assumes the stick is centered and sets the minimum value to 0 and
78 // the maximum value to 2 times the centered reading. Returns 0 if no
79 // joystick was detected, 1 if everything is ok.
80 // joy_init() is called.
81
82 #if defined (__NT__)
83 extern int joy_init(int joy, int spjoy);
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 // The following 3 routines can be used to zero in on better joy
95 // calibration factors. To use them, ask the user to hold the stick
96 // in either the upper left, lower right, or center and then have them
97 // press a key or button and then call the appropriate one of these
98 // routines, and it will read the stick and update the calibration factors.
99 // Usually, assuming that the stick was centered when joy_init was
100 // called, you really only need to call joy_set_lr, since the upper
101 // left position is usually always 0,0 on most joys.  But, the safest
102 // bet is to do all three, or let the user choose which ones to set.
103
104 extern void joy_set_ul();
105 extern void joy_set_lr();
106 extern void joy_set_cen();
107
108
109 //==========================================================================
110 // This reads the joystick. X and Y will be between -128 and 127.
111 // Takes about 1 millisecond in the worst case when the stick
112 // is in the lower right hand corner. Always returns 0,0 if no stick
113 // is present.
114
115 extern void joy_get_pos( int *x, int *y );
116
117 //==========================================================================
118 // This just reads the buttons and returns their status.  When bit 0
119 // is 1, button 1 is pressed, when bit 1 is 1, button 2 is pressed.
120 extern int joy_get_btns();
121
122 //==========================================================================
123 // This returns the number of times a button went either down or up since
124 // the last call to this function.
125 extern int joy_get_button_up_cnt( int btn );
126 extern int joy_get_button_down_cnt( int btn );
127
128 //==========================================================================
129 // This returns how long (in approximate milliseconds) that each of the
130 // buttons has been held down since the last call to this function.
131 // It is the total time... say you pressed it down for 3 ticks, released
132 // it, and held it down for 6 more ticks. The time returned would be 9.
133 extern fix joy_get_button_down_time( int btn );
134
135 extern ubyte joy_read_raw_buttons();
136 extern ubyte joystick_read_raw_axis( ubyte mask, int * axis );
137 extern void joy_flush();
138 extern ubyte joy_get_present_mask();
139 extern void joy_set_timer_rate(int max_value );
140 extern int joy_get_timer_rate();
141
142 extern int joy_get_button_state( int btn );
143 extern void joy_set_cen_fake(int channel);
144 extern ubyte joy_read_stick( ubyte masks, int *axis );
145 extern void joy_get_cal_vals(int *axis_min, int *axis_center, int *axis_max);
146 extern void joy_set_cal_vals(int *axis_min, int *axis_center, int *axis_max);
147 extern void joy_set_btn_values( int btn, int state, fix timedown, int downcount, int upcount );
148 extern int joy_get_scaled_reading( int raw, int axn );
149 extern void joy_set_slow_reading( int flag );
150
151 #ifdef _WIN32
152 extern int joy95_init_stick(int joy, int spjoy);
153 #endif
154
155
156 #endif