Repository files navigation

• Project homepage —https://magnum.graphics/
• Documentation —https://doc.magnum.graphics/
• GitHub project page —https://github.com/mosra/magnum-singles

There are the following single-header libraries at the moment. This list willgrow with more Magnum features being exposed this way.

^[1] — lines of code after a preprocessor run, with system includesexpanded. Gathered using GCC 14.2 and libstdc++, unless said otherwise.

^[2] — not a total size due to inter-library dependencies

^[3] — gathered using Clang 18.1 and libc++, since libstdc++ doesn'thave a forward declaration forstd::array /std::vector

^[4] — gathered using GCC 14.2, libstdc++ and-std=c++17

Single-header libraries provided here aregenerated from multi-file sourcesin the Magnum project. This is done for two reasons — first, documentation andtest coverage is much easier to maintain in the setting of a bigger project,avoiding any redundancy or duplicated efforts. Second, because the resultingfiles are generated with non-essential parts stripped away, there's no need toworry about bloating them due to original implementations having extensivedocumentation or rarely used features.

With the goal being easy integration, the files are deliberately free of allcomments and documentation blocks to keep their size small. Documentation foreach library is provided in the official Magnum documentation, linked from thetable above. Each library file contains the same documentation link, togetherwith a concrete Git revision it was generated from and a changelog for a fewversions back for easier overview when updating.

For more information read thesingle-header library docs. The libraries are generatedusingacme.py, which is a part of Corrade.See its documentation, if youare interested. Particular libraries are introduced on the Magnum blog:

• Lightweight but still STL-compatible unique pointer(Jan 16, 2019)
• Array view implementations in Magnum(Feb 18, 2019)
• Forward-declaring STL container types(Mar 28, 2019)
• Multi-dimensional strided array views in Magnum(Apr 30, 2019)
• Convenient CPU feature detection and dispatch(Aug 2, 2022)

Testing done in this repository is mainly to ensure the libraries are generatedcorrectly. Extensive testing on variety of compilers and OSes with > 99% testcoverage is done in the Magnum Project itself. See theBuild Status page for moreinformation.

As always, bug reports, feature requests and code contributions are verywelcome. However again please note the files in this repository are generatedfrom original sources in thecorrade andmagnum repositories, meaning that ideallyall PRs should go there instead, as there's a better infrastructure fordocumentation and testing. We don't enforce this rule though — if you have animportant bugfix, it's better if you submit it here than not at all 😉

All libraries are tested on these platforms:

• Linux and embedded Linux
• Windows,Windows RT (Store/Phone)
• macOS,iOS
• Android
• Web (asm.js orWebAssembly),throughEmscripten

And on these compilers:

• GCC 4.8.1 and newer (and equivalent MinGW-w64 version)
• Clang 6.0 and newer (or AppleClang 10.0 and newer), bothlibstdc++andlibc++
• MSVC 2015 and newer

• Project homepage —https://magnum.graphics/
• Documentation —https://doc.magnum.graphics/
• GitHub —https://github.com/mosra/magnum-singles and the#magnum topic
• GitLab —https://gitlab.com/mosra/magnum-singles
• Gitter community chat —https://gitter.im/mosra/magnum
• E-mail —info@magnum.graphics
• Google Groups mailing list —magnum-engine@googlegroups.com(archive)
• Twitter —https://twitter.com/czmosra and the#MagnumEngine hashtag

See also the Magnum ProjectContact & Support pagefor further information.

Libraries presented here are a result of a dedicated work by many communitymembers. List of all contributors to the Magnum Project can be foundin the documentation.

Magnum is licensed under the MIT/Expat license, see theCOPYING filefor details.