aboutsummaryrefslogtreecommitdiff
path: root/common/system.h
diff options
context:
space:
mode:
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;
/**