[AD] JOY_TYPE_* documentation

[ Thread Index | Date Index | More lists.liballeg.org/allegro-developers Archives ]


I just noticed that these were only documented in DOS. I know it's not too 
useful on other platforms, where there are two, one or no joystick drivers 
to pick from, but it might leave the impression that Allegro's joystick 
support is limited to DOS.
Proposed documentation update attached. The joystick specific section of 
the manual could use a bit of an overhaul as well, I'm not sure if and 
when I have time to do that though.

Evert
Index: docs/src/allegro._tx
===================================================================
RCS file: /cvsroot/alleg/allegro/docs/src/allegro._tx,v
retrieving revision 1.323
diff -u -r1.323 allegro._tx
--- docs/src/allegro._tx	30 Apr 2005 18:55:11 -0000	1.323
+++ docs/src/allegro._tx	30 Apr 2005 19:07:10 -0000
@@ -3520,7 +3520,7 @@
 @@int @install_joystick(int type);
 @xref remove_joystick, load_joystick_data, calibrate_joystick
 @xref calibrate_joystick_name, poll_joystick, Standard config variables
-@domain.hid JOY_TYPE_*/DOS
+@xref JOY_TYPE_*/DOS, JOY_TYPE_*/Windows, JOY_TYPE_*/Linux
 @eref exjoy
 @shortdesc Initialises the joystick.
    Initialises the joystick, and calibrates the centre position value. The 
@@ -11979,6 +11979,30 @@
 cannot be differentiated and are both reported as 16-bit desktops. See
 below for the consequences for windowed and overlay DirectX drivers.
 
+@@Drivers @JOY_TYPE_*/Windows
+@shortdesc Supported Windows joystick drivers.
+@xref install_joystick
+   The Windows library supports the following type parameters for the 
+   install_joystick() function:
+<ul><li>
+   JOY_TYPE_AUTODETECT<br>
+      Attempts to autodetect your joystick hardware. It will use information 
+      from the configuration file if one is available (this can be created 
+      using the setup utility or by calling the save_joystick_data() function),
+      so you can always use JOY_TYPE_AUTODETECT in your code and then select 
+      the exact hardware type from the setup program.
+<li>
+   JOY_TYPE_NONE<br>
+      Dummy driver for machines without any joystick.
+<li>
+   JOY_TYPE_DIRECTX<br>
+      Use DirectInput to acces the joystick.
+<li>
+   JOY_TYPE_WIN32<br>
+      Use the regular Win32 interface rather than DirectInput to acces the
+      joystick.
+</ul>
+
 @@Drivers @GFX_*/Windows
 @xref set_gfx_mode
 @shortdesc Supported Windows graphic drivers.
@@ -12313,6 +12337,27 @@
 command. You could add another grep to filter only lines with text like
 `keyboard' or `allegro'.
 
+@@Drivers @JOY_TYPE_*/Linux
+@shortdesc Supported Linux joystick drivers.
+@xref install_joystick
+   The Linux library supports the following type parameters for the 
+   install_joystick() function:
+<ul><li>
+   JOY_TYPE_AUTODETECT<br>
+      Attempts to autodetect your joystick hardware. It will use information 
+      from the configuration file if one is available (this can be created 
+      using the setup utility or by calling the save_joystick_data() function),
+      so you can always use JOY_TYPE_AUTODETECT in your code and then select 
+      the exact hardware type from the setup program.
+<li>
+   JOY_TYPE_NONE<br>
+      Dummy driver for machines without any joystick.
+<li>
+   JOY_TYPE_LINUX_ANALOGUE<br>
+      Regular joystick interface. Joystick support needs to be enabled in your
+      kernel.
+</ul>
+
 @@Drivers @GFX_*/Linux
 @xref set_gfx_mode, GFX_*/X
 @shortdesc Supported Linux console graphic drivers.


Mail converted by MHonArc 2.6.19+ http://listengine.tuxfamily.org/