Pages

Getting started Get started with Magnum in matter of minutes.
- Downloading and building Guide how to download and build Magnum on different platforms.
- Downloading and building plugins Guide how to download and build plugins for the Magnum engine.
- Downloading and building integration libraries Guide how to download and build integration libraries for the Magnum engine.
- Downloading and building extras Guide how to download and build extras for Magnum engine.
- Downloading and building examples Guide how to download and build examples for the Magnum engine.
- Usage with CMake Guide how to find and use Magnum with CMake build system.
- Plugin usage with CMake Guide how to find and use static Magnum plugins with CMake build system.
- Integration library usage with CMake Guide how to find and use Magnum integration libraries with CMake build system.
- Extras library usage with CMake Guide how to find and use Magnum Extras with CMake build system.
Feature guide Fundamental principles and design goals.
- Platform support Integration into windowing toolkits and creation of windowless contexts.
- Type system Type aliases, naming and compatibility with OpenGL and GLSL types.
- Operations with matrices and vectors Introduction to essential classes of the graphics pipeline.
- 2D and 3D transformations Introduction to essential operations on vectors and points.
- Loading and using plugins Extending Magnum with additional functionality.
- OpenGL wrapping layer Overview of the base OpenGL wrapper API.
- Builtin shaders Overview and basic usage of builtin shaders.
- Using scene graph Overview of scene management capabilities.
- Collision detection Collection of simple shapes for high performance collision detection.
- Debugging helpers Convenience classes to help you during development.
Platform-specific guides General information, tips and troubleshooting for particular platforms.
- OpenGL and OpenGL ES platforms Information common for all platforms that support OpenGL and OpenGL ES.
- Linux Tips and tricks for Linux platforms.
- Windows Tips and tricks for Windows platforms.
- macOS Tips and tricks for macOS.
- iOS Building, testing and deploying apps for Apple iOS platforms.
- Android Building and deploying Android projects.
- HTML5 and WebGL Building, testing and deploying HTML5 and WebGL projects.
Examples Learn by example to get quickly up to speed.
- Your first triangle Basic rendering with builtin shaders.
- Primitives Importing mesh data, 3D transformations and input handling.
- Textured triangle Importing image data, texturing and custom shaders.
- Model viewer Scene graph, resource manager and model importing.
- Triangle using plain GLFW Shows how to use Magnum with custom platform integration APIs.
- Triangle using sokol_gfx Shows how to use custom renderers with Magnum.
- Area lights Basic real-time area lights.
- Audio Shows how to play spatialized audio with Magnum.
- Bullet Physics Integration of Bullet Physics into Magnum.
- Cube map Demonstrates usage of cube map textures and texture blending.
- Leap Motion Integration of the LeapMotion SDK into Magnum.
- Motion blur Accumulates multiple frames together to create a motion blur effect.
- Oculus VR Integration of the Oculus SDK into Magnum.
- Object picking Usage of multiple framebuffer attachments to implement object picking.
- Shadow map Showcases the Parallel Split / Cascade shadow mapping technique.
- Text rendering Showcase of Magnum distance-field text rendering.
- WebVR Basic WebVR application.
Tips and tricks Hints for better productivity and performance.
- Method chaining Little feature helping to reduce typing and encourage best practices.
- Writing portable applications How to support different platforms and different OpenGL capabilities within one codebase.
- Speeding up compilation Techniques for reducing compilation times.
- Troubleshooting Various tricks to overcome common building and rendering issues.
Utilities Command-line utilities for system information and data conversion.
- Magnum GL Info Displays information about Magnum engine OpenGL capabilities.
- Magnum OpenAL Info Displays information about Magnum OpenAL capabilities.
- Distance Field conversion utility Converts red channel of an image to distance field representation.
- Font conversion utility Converts font to raster one of given atlas size.
- Image conversion utility Converts images of different formats.
OpenGL State of OpenGL support, version and extension requirements.
- Command mapping List of OpenGL commands corresponding to particular Magnum API.
- Support state List of (un)supported OpenGL features and extensions.
- Deprecated OpenGL API list
- Driver workarounds List of OpenGL driver workarounds used by Magnum.
- Functionality requiring OpenGL 3.0
- Functionality requiring OpenGL 3.1
- Functionality requiring OpenGL 3.2
- Functionality requiring OpenGL 3.3
- Functionality requiring OpenGL 4.0
- Functionality requiring OpenGL 4.1
- Functionality requiring OpenGL 4.2
- Functionality requiring OpenGL 4.3
- Functionality requiring OpenGL 4.4
- Functionality requiring OpenGL 4.5
- Functionality requiring OpenGL 4.6
- Functionality requiring specific OpenGL extension
- Functionality requiring desktop OpenGL
- Functionality requiring OpenGL ES 2.0 or WebGL 1.0
- Functionality requiring OpenGL ES 3.0
- Functionality requiring OpenGL ES 3.1
- Functionality requiring OpenGL ES 3.2
- Functionality requiring specific OpenGL ES extension
- Functionality requiring OpenGL ES or desktop OpenGL
- Functionality requiring WebGL 2.0
- Functionality requiring specific WebGL extension
OpenAL State of OpenAL support, version and extension requirements.
- OpenAL support state List of (un)supported OpenAL features and extensions.
- Functionality requiring specific OpenAL extension
Changelog
- Plugins
- Integration
- Extras
- Examples
Archived changelogs
Developers guide Checklists for developing new things in Magnum itself.
Coding style Coding style and best practices to preserve maintainability and consistent style across whole project.
Debug output operators for custom types
Deprecated list