From 10de569755222035cc87f26aad5a7b96f1848e2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 20 Dec 2012 15:57:47 +0100 Subject: [PATCH] Doc++ --- doc/portability.dox | 5 +++-- src/Platform/Sdl2Application.h | 6 ++++-- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/doc/portability.dox b/doc/portability.dox index fb0d32d8d..77d359ebb 100644 --- a/doc/portability.dox +++ b/doc/portability.dox @@ -136,7 +136,8 @@ macro is also aliased to MAGNUM_APPLICATION_MAIN() to save you typing. Example application, which targets both embedded Linux (using plain X and EGL) and desktop (using SDL2 toolkit). Thanks to static polymorphism most of the -functions will work on both without changes: +functions will work on both without changes, the main difference will be in +particular *Event class implementations: @code #ifndef MAGNUM_TARGET_GLES #include @@ -165,7 +166,7 @@ class MyApplication: public ApplicationBase { // ... } - void keyPressEvent(Key key, Modifiers modifiers, const Vector2i& position) { + void keyPressEvent(KeyEvent& event) override { // ... } }; diff --git a/src/Platform/Sdl2Application.h b/src/Platform/Sdl2Application.h index 14c375628..00aad8e99 100644 --- a/src/Platform/Sdl2Application.h +++ b/src/Platform/Sdl2Application.h @@ -170,7 +170,8 @@ class Sdl2Application::InputEvent { /** * @brief %Modifier * - * @see Modifiers, KeyEvent::modifiers() + * @see Modifiers, KeyEvent::modifiers(), MouseEvent::modifiers(), + * MouseMoveEvent::modifiers() */ enum class Modifier: Uint16 { Shift = KMOD_SHIFT, /**< Shift */ @@ -185,7 +186,8 @@ class Sdl2Application::InputEvent { /** * @brief Set of modifiers * - * @see KeyEvent::modifiers() + * @see KeyEvent::modifiers(), MouseEvent::modifiers(), + * MouseMoveEvent::modifiers() */ typedef Corrade::Containers::EnumSet Modifiers;