aboutsummaryrefslogtreecommitdiff
path: root/doxygen_resources/pages
diff options
context:
space:
mode:
authorGarrett Brown <garbearucla@gmail.com>2014-03-02 17:04:45 -0800
committerGarrett Brown <themagnificentmrb@gmail.com>2016-12-01 18:08:29 -0800
commite2563f6529ea0f08fe153d6baa9dff0935ea8d65 (patch)
treea96d39b1dc64a0da9e13570ed4b869faede717a1 /doxygen_resources/pages
parent918e289427c97e9f108b1c9e2219537644ad4955 (diff)
[retroplayer] Game add-ons
Thanks to Themaister for rewind functionality, fetzerch for mouse support, file length check and cmake modifications, topfs2 for fixing a crash when loading game clients, eibma for fixing linux compilation errors, a1rwulf for catching a missing callback symbol and fixing some rebase errors, and to notspiff for helping with the rebrand and cmake.
Diffstat (limited to 'doxygen_resources/pages')
-rw-r--r--doxygen_resources/pages/mainpage.dox17
1 files changed, 17 insertions, 0 deletions
diff --git a/doxygen_resources/pages/mainpage.dox b/doxygen_resources/pages/mainpage.dox
index 1c42e87cf2..5017adfe18 100644
--- a/doxygen_resources/pages/mainpage.dox
+++ b/doxygen_resources/pages/mainpage.dox
@@ -148,6 +148,18 @@
\defgroup mouse Mouse
\ingroup input
Everything around mouse
+
+ Mouse input is processed by \ref CInputManager and forwarded to
+ registered mouse handlers (e.g. game clients) or as actions to the UI:
+
+ - If no mouse handlers are registered or if they don't consume events,
+ the mouse input events are forwarded to the UI via \ref CInputManager::ProcessMouse.
+ - Clients (e.g. game clients implementing \ref MOUSE::IMouseInputHandler) call
+ \ref CInputManager::RegisterMouseHandler to register themselves as eligible
+ for mouse input events.
+ - Mouse events (from \ref CInputManager::OnEvent) are collected via implementations of
+ \ref MOUSE::IMouseDriverHandler and transformed into higher level features by
+ \ref MOUSE::IMouseButtonMap instances before they are sent to the handlers.
*/
/*!
@@ -169,6 +181,11 @@
*/
/*!
+ \defgroup games
+ Everything about RetroPlayer.
+*/
+
+/*!
\defgroup interface Interfaces
Everything around interfaces
*/