Browse Source

Platform: doc++.

pull/68/head
Vladimír Vondruš 12 years ago
parent
commit
3eff64ab62
  1. 4
      src/Magnum/Platform/AndroidApplication.h
  2. 4
      src/Magnum/Platform/GlutApplication.h
  3. 4
      src/Magnum/Platform/NaClApplication.h
  4. 4
      src/Magnum/Platform/Sdl2Application.h
  5. 6
      src/Magnum/Platform/WindowlessCglApplication.h
  6. 6
      src/Magnum/Platform/WindowlessGlxApplication.h
  7. 6
      src/Magnum/Platform/WindowlessWglApplication.h

4
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`,

4
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

4
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

4
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

6
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().

6
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().

6
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

Loading…
Cancel
Save