Browse Source

Platform: make Application and other conditional aliases searchable.

pull/364/head
Vladimír Vondruš 7 years ago
parent
commit
544f30b52f
  1. 2
      src/Magnum/Platform/AndroidApplication.h
  2. 2
      src/Magnum/Platform/EmscriptenApplication.h
  3. 2
      src/Magnum/Platform/GlfwApplication.h
  4. 2
      src/Magnum/Platform/GlxApplication.h
  5. 2
      src/Magnum/Platform/Screen.h
  6. 2
      src/Magnum/Platform/ScreenedApplication.h
  7. 2
      src/Magnum/Platform/Sdl2Application.h
  8. 4
      src/Magnum/Platform/WindowlessCglApplication.h
  9. 4
      src/Magnum/Platform/WindowlessEglApplication.h
  10. 4
      src/Magnum/Platform/WindowlessGlxApplication.h
  11. 4
      src/Magnum/Platform/WindowlessIosApplication.h
  12. 4
      src/Magnum/Platform/WindowlessWglApplication.h
  13. 4
      src/Magnum/Platform/WindowlessWindowsEglApplication.h
  14. 2
      src/Magnum/Platform/XEglApplication.h

2
src/Magnum/Platform/AndroidApplication.h

@ -54,6 +54,8 @@ namespace Magnum { namespace Platform {
/** @nosubgrouping
@brief Android application
@m_keywords{Application}
Application running on Android.
This application library is available only on

2
src/Magnum/Platform/EmscriptenApplication.h

@ -57,6 +57,8 @@ namespace Magnum { namespace Platform {
/** @nosubgrouping
@brief Emscripten application
@m_keywords{Application}
Application running on Emscripten.
This application library is available only on

2
src/Magnum/Platform/GlfwApplication.h

@ -58,6 +58,8 @@ namespace Implementation {
/** @nosubgrouping
@brief GLFW application
@m_keywords{Application}
Application using the [GLFW](http://glfw.org) toolkit. Supports keyboard and
mouse handling with support for changing cursor and mouse tracking and warping.

2
src/Magnum/Platform/GlxApplication.h

@ -40,6 +40,8 @@ namespace Magnum { namespace Platform {
/**
@brief GLX application
@m_keywords{Application}
Application using pure X11 and GLX. Supports keyboard and mouse handling.
This application library is available on desktop OpenGL and

2
src/Magnum/Platform/Screen.h

@ -50,6 +50,8 @@ CORRADE_ENUMSET_OPERATORS(PropagatedScreenEvents)
/**
@brief Base for application screens
@m_keywords{Screen}
See @ref BasicScreenedApplication for more information.
If exactly one application header is included, this class is also aliased to

2
src/Magnum/Platform/ScreenedApplication.h

@ -40,6 +40,8 @@ namespace Magnum { namespace Platform {
/**
@brief Base for applications with screen management
@m_keywords{ScreenedApplication}
Manages list of screens and propagates events to them.
If exactly one application header is included, this class is also aliased to

2
src/Magnum/Platform/Sdl2Application.h

@ -70,6 +70,8 @@ namespace Implementation {
/** @nosubgrouping
@brief SDL2 application
@m_keywords{Application}
Application using [Simple DirectMedia Layer](http://www.libsdl.org/) toolkit.
Supports keyboard and mouse handling.

4
src/Magnum/Platform/WindowlessCglApplication.h

@ -50,6 +50,8 @@ namespace Magnum { namespace Platform {
/**
@brief Windowless CGL context
@m_keywords{WindowlessGLContext}
GL context used in @ref WindowlessCglApplication. Does not have any default
framebuffer. It is built if `WITH_WINDOWLESSCGLAPPLICATION` is enabled in
CMake.
@ -143,6 +145,8 @@ class WindowlessCglContext::Configuration {
/**
@brief Windowless CGL application
@m_keywords{WindowlessApplication}
Application for offscreen rendering using @ref WindowlessCglContext. This
application library is available on desktop OpenGL on macOS. It is built if
`WITH_WINDOWLESSCGLAPPLICATION` is enabled in CMake.

4
src/Magnum/Platform/WindowlessEglApplication.h

@ -52,6 +52,8 @@ namespace Magnum { namespace Platform {
/**
@brief Windowless EGL context
@m_keywords{WindowlessGLContext}
GL context using EGL without any windowing system, used in
@ref WindowlessEglApplication. Does not have any default framebuffer. It is
built if `WITH_WINDOWLESSEGLAPPLICATION` is enabled in CMake.
@ -247,6 +249,8 @@ CORRADE_ENUMSET_OPERATORS(WindowlessEglContext::Configuration::Flags)
/**
@brief Windowless EGL application
@m_keywords{WindowlessApplication}
Application for offscreen rendering using @ref WindowlessEglContext. This
application library is in theory available for all platforms for which EGL
works (Linux desktop or ES, @ref CORRADE_TARGET_IOS "iOS",

4
src/Magnum/Platform/WindowlessGlxApplication.h

@ -56,6 +56,8 @@ namespace Magnum { namespace Platform {
/**
@brief Windowless GLX context
@m_keywords{WindowlessGLContext}
GL context using pure X11 and GLX, used in @ref WindowlessGlxApplication. Does
not have any default framebuffer. It is built if `WITH_WINDOWLESSGLXAPPLICATION`
is enabled in CMake.
@ -241,6 +243,8 @@ CORRADE_ENUMSET_OPERATORS(WindowlessGlxContext::Configuration::Flags)
/**
@brief Windowless GLX application
@m_keywords{WindowlessApplication}
Application for offscreen rendering using @ref WindowlessGlxContext. This
application library is available on desktop OpenGL and
@ref MAGNUM_TARGET_DESKTOP_GLES "OpenGL ES emulation on desktop" on Linux. It

4
src/Magnum/Platform/WindowlessIosApplication.h

@ -51,6 +51,8 @@ namespace Magnum { namespace Platform {
/**
@brief Windowless iOS context
@m_keywords{WindowlessGLContext}
GL context using EAGL on iOS, used in @ref WindowlessIosApplication. Does not
have any default framebuffer. It is built if `WITH_WINDOWLESSIOSAPPLICATION` is
enabled in CMake.
@ -138,6 +140,8 @@ class WindowlessIosContext::Configuration {
/**
@brief Windowless iOS application
@m_keywords{WindowlessApplication}
Application for offscreen rendering using @ref WindowlessIosContext. Does not
have any default framebuffer. It is built if `WITH_WINDOWLESSIOSAPPLICATION` is
enabled in CMake.

4
src/Magnum/Platform/WindowlessWglApplication.h

@ -57,6 +57,8 @@ namespace Magnum { namespace Platform {
/**
@brief Windowless WGL context
@m_keywords{WindowlessGLContext}
GL context using pure WINAPI, used in @ref WindowlessWglApplication. It is
built if `WITH_WINDOWLESSWGLAPPLICATION` is enabled in CMake.
@ -241,6 +243,8 @@ CORRADE_ENUMSET_OPERATORS(WindowlessWglContext::Configuration::Flags)
/**
@brief Windowless WGL application
@m_keywords{WindowlessApplication}
Application for offscreen rendering using @ref WindowlessWglContext. This
application library is available on desktop OpenGL on Windows. It is built if
`WITH_WINDOWLESSWGLAPPLICATION` is enabled in CMake.

4
src/Magnum/Platform/WindowlessWindowsEglApplication.h

@ -52,6 +52,8 @@ namespace Magnum { namespace Platform {
/**
@brief Windowless Windows/EGL context
@m_keywords{WindowlessGLContext}
GL context using pure WINAPI and EGL, used in @ref WindowlessWindowsEglApplication.
It is built if `WITH_WINDOWLESSWINDOWSEGLAPPLICATION` is enabled in CMake.
@ -211,6 +213,8 @@ CORRADE_ENUMSET_OPERATORS(WindowlessWindowsEglContext::Configuration::Flags)
/**
@brief Windowless Windows/EGL application
@m_keywords{WindowlessApplication}
Application for offscreen rendering using @ref WindowlessWindowsEglContext.
This application library is available on OpenGL ES (also ANGLE) on Windows. It
is built if `WITH_WINDOWLESSWINDOWSEGLAPPLICATION` is enabled in CMake.

2
src/Magnum/Platform/XEglApplication.h

@ -40,6 +40,8 @@ namespace Magnum { namespace Platform {
/**
@brief X/EGL application
@m_keywords{Application}
Application using pure X11 and EGL. Supports keyboard and mouse handling.
This application library is available on both desktop OpenGL and

Loading…
Cancel
Save