Browse Source

Doc++

pull/34/head
Vladimír Vondruš 13 years ago
parent
commit
02afa105db
  1. 10
      doc/building.dox
  2. 9
      doc/platform.dox
  3. 4
      src/Platform/AbstractXApplication.h

10
doc/building.dox

@ -104,12 +104,10 @@ within QtCreator by adding new `make install` build rule.
@subsubsection building-windows-troubleshooting Windows troubleshooting @subsubsection building-windows-troubleshooting Windows troubleshooting
If CMake isn't able to find dependencies (e.g. %Corrade is not found) and you If CMake isn't able to find dependencies (e.g. %Corrade is not found), point
have installed them to MinGW directory, point to `CMAKE_FIND_ROOT_PATH` to `CMAKE_FIND_ROOT_PATH` and `CMAKE_INSTALL_PREFIX` to installation prefix of
MinGW installation prefix, e.g. specify `-DCMAKE_FIND_ROOT_PATH=C:/MinGW/` dependency libraries, e.g. specify `-DCMAKE_FIND_ROOT_PATH=C:/MinGW/` CMake
CMake parameter. parameter.
See also Corrade's @ref building-corrade-windows-troubleshooting "troubleshooting section".
@subsection building-features Enabling or disabling features @subsection building-features Enabling or disabling features

9
doc/platform.dox

@ -55,7 +55,8 @@ directly in `main()`, but for convenience and portability it's better to use
To simplify the porting, the library provides `Platform::Application` typedef To simplify the porting, the library provides `Platform::Application` typedef
and `MAGNUM_APPLICATION_MAIN()` macro (but only if only one application header and `MAGNUM_APPLICATION_MAIN()` macro (but only if only one application header
is included, to avoid ambiguity). Changing the code to use different toolkit is is included, to avoid ambiguity). Changing the code to use different toolkit is
then matter of replacing only the <tt>#</tt>`include` statement. then matter of replacing only the <tt>#</tt>`include` statement (and changing
one line in CMake build script, as you see later).
Barebone application implementation which will just clear the window to dark Barebone application implementation which will just clear the window to dark
blue color is shown in the following code listing. blue color is shown in the following code listing.
@ -76,6 +77,7 @@ class MyApplication: public Platform::Application {
public: public:
MyApplication(const Arguments& arguments); MyApplication(const Arguments& arguments);
private:
void viewportEvent(const Vector2i& viewport) override; void viewportEvent(const Vector2i& viewport) override;
void drawEvent() override; void drawEvent() override;
}; };
@ -166,8 +168,9 @@ to it.
Again, to simplify porting, you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}` Again, to simplify porting, you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}`
and `${MAGNUM_WAPPLICATION_LIBRARIES}` aliases (or `${MAGNUM_WINDOWLESSAPPLICATION_INCLUDE_DIRS}`, `${MAGNUM_WINDOWLESSAPPLICATION_LIBRARIES}` for windowless applications), but and `${MAGNUM_WAPPLICATION_LIBRARIES}` aliases (or `${MAGNUM_WINDOWLESSAPPLICATION_INCLUDE_DIRS}`, `${MAGNUM_WINDOWLESSAPPLICATION_LIBRARIES}` for windowless applications), but
only if only one application (windowless application) component is requested to only if only one application (windowless application) component is requested to
avoid ambiguity. Changing the code to use different toolkit is then matter of avoid ambiguity. Changing the build script to use different toolkit is then
replacing only the requested `*Application` component. matter of replacing only the requested `*Application` component (and one
<tt>#</tt>`include` line in the actual code, as said above).
@code @code
find_package(Magnum REQUIRED GlutApplication) find_package(Magnum REQUIRED GlutApplication)

4
src/Platform/AbstractXApplication.h

@ -193,8 +193,8 @@ CORRADE_ENUMSET_OPERATORS(AbstractXApplication::Flags)
@brief %Configuration @brief %Configuration
Double-buffered OpenGL context. Double-buffered OpenGL context.
@see @ref GlxApplication(), @ref XEglApplication(), @ref createContext(), @see @ref GlxApplication::GlxApplication(), @ref XeglApplication::XEglApplication(),
@ref tryCreateContext() @ref createContext(), @ref tryCreateContext()
@todo GLX_ARB_create_context_robustness/EGL_EXT_create_context_robustness @todo GLX_ARB_create_context_robustness/EGL_EXT_create_context_robustness
*/ */
class AbstractXApplication::Configuration { class AbstractXApplication::Configuration {

Loading…
Cancel
Save