aboutsummaryrefslogtreecommitdiff
path: root/common/system.h
diff options
context:
space:
mode:
authorJohannes Schickel2009-06-29 23:23:29 +0000
committerJohannes Schickel2009-06-29 23:23:29 +0000
commitb37beb4493f69de1e2338fcf10bb1852ba864bc7 (patch)
tree9cebd661ae7442e3e8d6e520abb3dd4175b4b4b0 /common/system.h
parent267efdc8742fb64e72bc50e78e1d719451f2144e (diff)
downloadscummvm-rg350-b37beb4493f69de1e2338fcf10bb1852ba864bc7.tar.gz
scummvm-rg350-b37beb4493f69de1e2338fcf10bb1852ba864bc7.tar.bz2
scummvm-rg350-b37beb4493f69de1e2338fcf10bb1852ba864bc7.zip
Add some more explanation to Graphics::CursorManager::showMouse and OSystem::showMouse.
svn-id: r41968
Diffstat (limited to 'common/system.h')
-rw-r--r--common/system.h13
1 files changed, 12 insertions, 1 deletions
diff --git a/common/system.h b/common/system.h
index a8f3b1c903..5b3c208661 100644
--- a/common/system.h
+++ b/common/system.h
@@ -673,7 +673,18 @@ public:
*/
//@{
- /** Show or hide the mouse cursor. */
+ /**
+ * Show or hide the mouse cursor.
+ *
+ * Currently the backend is not required to immediately draw the
+ * mouse cursor on showMouse(true).
+ *
+ * TODO: We might want to reconsider this fact,
+ * check Graphics::CursorManager::showMouse for some details about
+ * this.
+ *
+ * @see Graphics::CursorManager::showMouse
+ */
virtual bool showMouse(bool visible) = 0;
/**