[AD] get_mouse_mickeys documentation

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


The documentation for get_mouse_mickeys seems to be unclear. Do the
variables go negative when the mouse is moved left or up? The docs
don't actually state that they do. I've attached a patch to fix it.
-- 
Regards, 
Ryan Patterson <mailto:cgamesplay@xxxxxxxxxx>
Index: docs/src/allegro._tx
===================================================================
RCS file: /cvsroot/alleg/allegro/docs/src/allegro._tx,v
retrieving revision 1.306
diff -u -p -r1.306 allegro._tx
--- docs/src/allegro._tx	17 Mar 2005 07:29:43 -0000	1.306
+++ docs/src/allegro._tx	18 Mar 2005 17:37:55 -0000
@@ -2727,9 +2727,14 @@ information for more details.
 @eref exmouse
 @shortdesc How far the mouse has moved since the last call to this function.
    Measures how far the mouse has moved since the last call to this 
-   function. The mouse will continue to generate movement mickeys even when 
-   it reaches the edge of the screen, so this form of input can be useful 
-   for games that require an infinite range of mouse movement.
+   function. The values of mickeyx and mickeyy will become negative if the 
+   mouse is moved left or up, respectively. The mouse will continue to 
+   generate movement mickeys even when it reaches the edge of the screen, so 
+   this form of input can be useful for games that require an infinite range 
+   of mouse movement.
+
+   Note that the infinite movement may not work in windowed mode, since under 
+   some platforms the mouse would leave the window.
 
 @@extern void (*@mouse_callback)(int flags);
 @xref install_mouse


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