This is a snapshot of a work-in-progress documentation theme. If you feel lost, miss something, or want to see the original Doxygen docs instead, head over to the archived version of this documentation page.

Magnum/Magnum.h file

Forward declarations for Magnum namespace.

Contents

Namespaces

namespace Magnum
Root namespace.
namespace Magnum::Math
Math library.

Defines

#define MAGNUM_BUILD_DEPRECATED
Build with deprecated API included.
#define MAGNUM_BUILD_STATIC
Static library build.
#define MAGNUM_BUILD_MULTITHREADED
Multi-threaded build.
#define MAGNUM_TARGET_GLES
OpenGL ES target.
#define MAGNUM_TARGET_GLES2
OpenGL ES 2.0 target.
#define MAGNUM_TARGET_GLES3
OpenGL ES 3.0 target.
#define MAGNUM_TARGET_DESKTOP_GLES
Desktop emulation of OpenGL ES target.
#define MAGNUM_TARGET_WEBGL
WebGL target.
#define MAGNUM_TARGET_HEADLESS
Headless target.

Define documentation

#define MAGNUM_BUILD_DEPRECATED

Build with deprecated API included.

Defined if the library contains deprecated API (which will be removed in the future). To preserve backward compatibility, Magnum is by default built with deprecated API included.

#define MAGNUM_BUILD_STATIC

Static library build.

Defined if built as static libraries. Default are shared libraries.

#define MAGNUM_BUILD_MULTITHREADED

Multi-threaded build.

Defined if the library is built in a way that allows multiple thread-local Magnum contexts. Enabled by default.

#define MAGNUM_TARGET_GLES

OpenGL ES target.

Defined if the engine is built for OpenGL ES 3.0 or OpenGL ES 2.0.

#define MAGNUM_TARGET_GLES2

OpenGL ES 2.0 target.

Defined if the engine is built for OpenGL ES 2.0. Implies also MAGNUM_TARGET_GLES.

#define MAGNUM_TARGET_GLES3

OpenGL ES 3.0 target.

Defined if the engine is built for OpenGL ES 3.0. Implies also MAGNUM_TARGET_GLES.

#define MAGNUM_TARGET_DESKTOP_GLES

Desktop emulation of OpenGL ES target.

Defined if the engine is built for OpenGL ES 3.0 or OpenGL ES 2.0 emulated within standard desktop OpenGL. Implies also MAGNUM_TARGET_GLES.

#define MAGNUM_TARGET_WEBGL

WebGL target.

Defined if the engine is built for WebGL (using Emscripten). WebGL is nearly equivalent to OpenGL ES 2.0, thus in most cases you don't need to treat it differently, but there are some specific restrictions and features which you might want to be aware of. Implies also MAGNUM_TARGET_GLES and MAGNUM_TARGET_GLES2.

#define MAGNUM_TARGET_HEADLESS

Headless target.

Defined if the engine is built for use on a headless machine (without any graphical desktop environment). Basically it means that EGL with no display attachment is being used everywhere instead of platform-specific toolkits like CGL, GLX or WGL. Note that this might not be supported on all platforms, see Platform::WindowlessEglApplication for more information.