commented headers in app/ directory

[l2e.git] / src / app / Input.h

diff --git a/src/app/Input.h b/src/app/Input.h
index 415d11f0890ade422591d14753570f230b4bba05..4df4685e0c986b3dd7d7b3b229b4174820dc49c5 100644 (file)
--- a/src/app/Input.h
+++ b/src/app/Input.h
@@ -13,6 +13,19 @@
 
 namespace app {
 
+/// Maps SDL key events to virtual buttons.
+/// Records the state and whether it was pressed/released in the current
+/// iteration.
+/// Multiple buttons can be passed by ORing them bitwise.
+/// The MapKey(SDLKey, Button) function introduces a mapping for the given key
+/// to the given virtual button. Each key can be assigned to one button only,
+/// but there is no limit (well, except for memory, I guess) on how many keys
+/// may map to the same button.
+/// Each iteration should first call ResetInteractiveState() to drop the just
+/// pressed/released information and then pass each SDL_KeyboardEvent to
+/// HandleKeyboardEvent(const SDL_KeyboardEvent &).
+/// The four DEBUG_? buttons do not map to any real SNES/Lufia 2 button and may
+/// be used for debugging or non-gameplay-related input.
 class Input {
 
 public: