Added mouse_ioctl to complete mouse.h

git-svn-id: svn://svn.cc65.org/cc65/trunk@3561 b7a2c559-68d2-44c3-8de9-860c34a00d81

diff --git a/doc/funcref.sgml b/doc/funcref.sgml
index 02da396ddf6c4fb3d4b26157cc76d5262df4aa43..4c87a757f57ddb122ded1d0bd2495e36ca6f2db9 100644 (file)
--- a/doc/funcref.sgml
+++ b/doc/funcref.sgml
@@ -277,7 +277,7 @@ function.
 <item><ref id="mouse_buttons" name="mouse_buttons">
 <item><ref id="mouse_pos" name="mouse_pos">
 <item><ref id="mouse_info" name="mouse_info">
-<!-- <item><ref id="mouse_ioctl" name="mouse_ioctl"> -->
+<item><ref id="mouse_ioctl" name="mouse_ioctl">
 </itemize>
 
 (incomplete)
@@ -3400,6 +3400,31 @@ used in presence of a prototype.
 </quote>
 
 
+<sect1>mouse_ioctl<label id="mouse_ioctl"><p>
+
+<quote>
+<descrip>
+<tag/Function/Call the driver specific ioctl function.
+<tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/
+<tag/Declaration/<tt/unsigned char __fastcall__ mouse_ioctl (unsigned char code, void* data);/
+<tag/Description/The function calls the IOCTL entry in the mouse driver,
+which is driver specific. The <tt/code/ parameter will choose between
+different IOCTL functions, and the <tt/data/ depends on code. The
+function returns an error code. The purpose of this function is to allow
+for driver specific extensions. See the documentation for a specific mouse
+driver for supported ioctl calls.
+<tag/Limits/<itemize>
+<item>Calling this function is non portable, because each driver may
+implement different ioctl calls (or none at all).
+<item>The function is only available as fastcall function, so it may only be
+used in presence of a prototype.
+</itemize>
+<tag/Availability/cc65
+<tag/Example/None.
+</descrip>
+</quote>
+
+
 <sect1>mouse_load_driver<label id="mouse_load_driver"><p>
 
 <quote>