hyperion::platform is a foundational C++ library for cross-platform projects, providing several common features to detect, work around, or abstract away the differences between various platforms and toolchains, such as operating system detection macros, CPU architecture detection macros, compiler and library feature detection macros, and bounds-checked numeric literals.
hyperion::platform is also a core library of the Hyperion game engine project. As such, it also provides a an optional feature specific to its usage in that and related projects, namely frame profiling support backed by Tracy. This is disabled by default (see the Quick Start Guide and the documentation for more on how to enable it).
See the Quick Start Guide for how to get started using hyperion::platform.
You can also find the rest of the project documentation here
After following the Quick Start Guide, you'll be able to use hyperion::platform in your project. A basic example of what you can do with hyperion::platform is below:
#include <hyperion/platform.h>
#include <hyperion/platform/types.h>
using hyperion::operator""_i32;
static constexpr auto the_meaning_of_life = 42_i32;
#if HYPERION_PLATFORM_IS_ARCHITECTURE(HYPERION_PLATFORM_ARCHITECTURE_ARM_V8)
// do something for ARM
#elif HYPERION_PLATFORM_IS_ARCHITECTURE(HYPERION_PLATFORM_ARCHITECTURE_X86_64)
// do something for x86_64
#else
// do something else
#endifFeel free to submit issues, pull requests, etc.!
When contributing code, please follow the general style expectations of Hyperion projects:
- Follow the project
.clang-format(except in judicious cases of templates or requires clauses ruining formatting), - Use trailing returns types,
- Use assign-init (e.g.
auto var = value;) instead of direct-init (e.g.auto var{value}), - By default, prefer simplicity and correctness over performance
hyperion::platform uses the MIT license.