diff options
Diffstat (limited to 'graphics/cursorman.h')
| -rw-r--r-- | graphics/cursorman.h | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/graphics/cursorman.h b/graphics/cursorman.h index 4cbd5bea12..f019e37b04 100644 --- a/graphics/cursorman.h +++ b/graphics/cursorman.h @@ -36,7 +36,21 @@ public: /** Query whether the mouse cursor is visible. */ bool isVisible(); - /** Show or hide the mouse cursor. */ + /** + * Show or hide the mouse cursor. + * + * This function does not call OSystem::updateScreen, when visible is true. + * This fact might result in a non visible mouse cursor if the caller does + * not call OSystem::updateScreen itself after a showMouse(true) call. + * + * TODO: We might want to reconsider this behavior, it might be confusing + * for the user to call OSystem::updateScreen separately, on the other + * hand OSystem::updateScreen might as well display unwanted changes on + * the screen. Another alternative would be to let the backend worry + * about this on OSystem::showMouse call. + * + * @see OSystem::showMouse. + */ bool showMouse(bool visible); /** |