From 3eff64ab62b3ac69803453253f87f2cc9cc609eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 17 Aug 2014 11:29:18 +0200 Subject: [PATCH] Platform: doc++. --- src/Magnum/Platform/AndroidApplication.h | 4 +++- src/Magnum/Platform/GlutApplication.h | 4 +++- src/Magnum/Platform/NaClApplication.h | 4 +++- src/Magnum/Platform/Sdl2Application.h | 4 +++- src/Magnum/Platform/WindowlessCglApplication.h | 6 ++++-- src/Magnum/Platform/WindowlessGlxApplication.h | 6 ++++-- src/Magnum/Platform/WindowlessWglApplication.h | 6 ++++-- 7 files changed, 24 insertions(+), 10 deletions(-) diff --git a/src/Magnum/Platform/AndroidApplication.h b/src/Magnum/Platform/AndroidApplication.h index 0660734cf..1cb730249 100644 --- a/src/Magnum/Platform/AndroidApplication.h +++ b/src/Magnum/Platform/AndroidApplication.h @@ -98,6 +98,8 @@ properly set **absolute** path to `toolchains/modules/` directory containing -DCMAKE_TOOLCHAIN_FILE="../toolchains/generic/Android-x86.cmake" cmake --build . +See @ref cmake for more information. + The compiled binaries will be put into `lib/armeabi-v7a` and `lib/x86`. You can then build the APK package simply by running `ant`. The resulting APK package can be then installed directly on the device or emulator using `adb install`. @@ -114,7 +116,7 @@ Request `%AndroidApplication` component, add `${MAGNUM_ANDROIDAPPLICATION_INCLUDE_DIRS}` to include path and link to `${MAGNUM_ANDROIDAPPLICATION_LIBRARIES}`. If no other application is requested, you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}` and -`${MAGNUM_APPLICATION_LIBRARIES}` aliases to simplify porting. See +`${MAGNUM_APPLICATION_LIBRARIES}` aliases to simplify porting. Again, see @ref building and @ref cmake for more information. Note that unlike on other platforms you need to create *shared library* instead of executable. The resulting binary then needs to be copied to `lib/armeabi-v7a` and `lib/x86`, diff --git a/src/Magnum/Platform/GlutApplication.h b/src/Magnum/Platform/GlutApplication.h index 1bab6db64..be6a91ba0 100644 --- a/src/Magnum/Platform/GlutApplication.h +++ b/src/Magnum/Platform/GlutApplication.h @@ -70,13 +70,15 @@ with these four commands: cmake --build . ./src/MyApplication # or ./src/Debug/MyApplication +See @ref cmake for more information. + ## General usage In CMake you need to request `%GlutApplication` component, add `${MAGNUM_GLUTAPPLICATION_INCLUDE_DIRS}` to include path and link to `${MAGNUM_GLUTAPPLICATION_LIBRARIES}`. If no other application is requested, you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}` and -`${MAGNUM_APPLICATION_LIBRARIES}` aliases to simplify porting. See +`${MAGNUM_APPLICATION_LIBRARIES}` aliases to simplify porting. Again, see @ref building and @ref cmake for more information. In C++ code you need to implement at least @ref drawEvent() to be able to draw diff --git a/src/Magnum/Platform/NaClApplication.h b/src/Magnum/Platform/NaClApplication.h index fd554540f..092e84251 100644 --- a/src/Magnum/Platform/NaClApplication.h +++ b/src/Magnum/Platform/NaClApplication.h @@ -109,6 +109,8 @@ location of your webserver to have the files installed in proper location (e.g. cmake --build . cmake --build . --target install +See @ref cmake for more information. + You can then open `MyApplication` through your webserver in Chrome (e.g. `http://localhost/nacl/MyApplication.html`). @@ -120,7 +122,7 @@ ES). Request `%NaClApplication` component, add `${MAGNUM_NACLAPPLICATION_INCLUDE_DIRS}` to include path and link to `${MAGNUM_NACLAPPLICATION_LIBRARIES}`. If no other application is requested, you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}` and -`${MAGNUM_APPLICATION_LIBRARIES}` aliases to simplify porting. See +`${MAGNUM_APPLICATION_LIBRARIES}` aliases to simplify porting. Again, see @ref building and @ref cmake for more information. In C++ code you need to implement at least @ref drawEvent() to be able to draw diff --git a/src/Magnum/Platform/Sdl2Application.h b/src/Magnum/Platform/Sdl2Application.h index 52b43cfe6..f963ed86a 100644 --- a/src/Magnum/Platform/Sdl2Application.h +++ b/src/Magnum/Platform/Sdl2Application.h @@ -76,6 +76,8 @@ with these four commands: cmake --build . ./src/MyApplication # or ./src/Debug/MyApplication +See @ref cmake for more information. + ## Bootstrap application for Emscripten Fully contained base application using @ref Sdl2Application for both desktop @@ -115,7 +117,7 @@ In case of Emscripten you need also `FindOpenGLES2.cmake`. Request `%Sdl2Application` component, add `${MAGNUM_SDL2APPLICATION_INCLUDE_DIRS}` to include path and link to `${MAGNUM_SDL2APPLICATION_LIBRARIES}`. If no other application is requested, you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}` -and `${MAGNUM_APPLICATION_LIBRARIES}` aliases to simplify porting. See +and `${MAGNUM_APPLICATION_LIBRARIES}` aliases to simplify porting. Again, see @ref building and @ref cmake for more information. In C++ code you need to implement at least @ref drawEvent() to be able to draw on the diff --git a/src/Magnum/Platform/WindowlessCglApplication.h b/src/Magnum/Platform/WindowlessCglApplication.h index 225ed3a53..0f751b16c 100644 --- a/src/Magnum/Platform/WindowlessCglApplication.h +++ b/src/Magnum/Platform/WindowlessCglApplication.h @@ -63,6 +63,8 @@ application with these four commands: cmake --build . ./src/MyApplication # or ./src/Debug/MyApplication +See @ref cmake for more information. + ## General usage In CMake you need to request `%WindowlessCglApplication` component, add @@ -70,8 +72,8 @@ In CMake you need to request `%WindowlessCglApplication` component, add `${MAGNUM_WINDOWLESSCGLAPPLICATION_LIBRARIES}`. If no other windowless application is requested, you can also use generic `${MAGNUM_WINDOWLESSAPPLICATION_INCLUDE_DIRS}` and -`${MAGNUM_WINDOWLESSAPPLICATION_LIBRARIES}` aliases to simplify porting. See -@ref building and @ref cmake for more information. +`${MAGNUM_WINDOWLESSAPPLICATION_LIBRARIES}` aliases to simplify porting. Again, +see @ref building and @ref cmake for more information. Place your code into @ref exec(). The subclass can be then used directly in `main()` -- see convenience macro @ref MAGNUM_WINDOWLESSCGLAPPLICATION_MAIN(). diff --git a/src/Magnum/Platform/WindowlessGlxApplication.h b/src/Magnum/Platform/WindowlessGlxApplication.h index 90eb770fb..49098fe94 100644 --- a/src/Magnum/Platform/WindowlessGlxApplication.h +++ b/src/Magnum/Platform/WindowlessGlxApplication.h @@ -69,6 +69,8 @@ application with these four commands: cmake --build . ./src/MyApplication # or ./src/Debug/MyApplication +See @ref cmake for more information. + ## General usage In CMake you need to request `%WindowlessGlxApplication` component, add @@ -76,8 +78,8 @@ In CMake you need to request `%WindowlessGlxApplication` component, add `${MAGNUM_WINDOWLESSGLXAPPLICATION_LIBRARIES}`. If no other windowless application is requested, you can also use generic `${MAGNUM_WINDOWLESSAPPLICATION_INCLUDE_DIRS}` and -`${MAGNUM_WINDOWLESSAPPLICATION_LIBRARIES}` aliases to simplify porting. See -@ref building and @ref cmake for more information. +`${MAGNUM_WINDOWLESSAPPLICATION_LIBRARIES}` aliases to simplify porting. Again, +see @ref building and @ref cmake for more information. Place your code into @ref exec(). The subclass can be then used directly in `main()` -- see convenience macro @ref MAGNUM_WINDOWLESSGLXAPPLICATION_MAIN(). diff --git a/src/Magnum/Platform/WindowlessWglApplication.h b/src/Magnum/Platform/WindowlessWglApplication.h index a21cf341d..3f1ecb623 100644 --- a/src/Magnum/Platform/WindowlessWglApplication.h +++ b/src/Magnum/Platform/WindowlessWglApplication.h @@ -64,6 +64,8 @@ application with these four commands: cmake --build . ./src/MyApplication # or ./src/Debug/MyApplication +See @ref cmake for more information. + ## General usage In CMake you need to request `%WindowlessWglApplication` component, add @@ -71,8 +73,8 @@ In CMake you need to request `%WindowlessWglApplication` component, add `${MAGNUM_WINDOWLESSWGLAPPLICATION_LIBRARIES}`. If no other windowless application is requested, you can also use generic `${MAGNUM_WINDOWLESSAPPLICATION_INCLUDE_DIRS}` and -`${MAGNUM_WINDOWLESSAPPLICATION_LIBRARIES}` aliases to simplify porting. See -@ref building and @ref cmake for more information. +`${MAGNUM_WINDOWLESSAPPLICATION_LIBRARIES}` aliases to simplify porting. Again, +see @ref building and @ref cmake for more information. Place your code into @ref exec(). The subclass can be then used in main function using @ref MAGNUM_WINDOWLESSWGLAPPLICATION_MAIN() macro. See