omni/core/Platform.h

↰ Parent directory: omni/core/

Helper macros to detect the current platform.

Source: omni/core/Platform.h

Included By

  • omni/core/Assert.h: Helper macros to provide assertion checking macros.

  • omni/extras/PathMap.h: A set of helper templates to provide platform specific behaviour around path handling.

  • omni/core/Api.h: Helper macros to provide API calling convention tags.

  • omni/extras/ForceLink.h: Provides functionality to force a symbol to be linked to a module instead of the optimizaer potentially removing it out.

Defines

  • OMNI_BREAK_POINT: Triggers a breakpoint. If no debugger is attached, the program terminates.

  • OMNI_PLATFORM_LINUX: Set to 1 if compiling a Linux build. Set to 0 otherwise. This symbol will always be defined even when not on a Linux build. It can thus be used to pass as parameters or in if-statements to modify behaviour based on the platform.

  • OMNI_PLATFORM_MACOS: Set to 1 if compiling a MacOS build. Set to 0 otherwise. This symbol will always be defined even when not on a MacOS build. It can thus be used to pass as parameters or in if-statements to modify behaviour based on the platform.

  • OMNI_PLATFORM_WINDOWS: Set to 1 if compiling a Windows build. Set to 0 otherwise. This symbol will always be defined even when not on a Windows build. It can thus be used to pass as parameters or in if-statements to modify behaviour based on the platform.

  • OMNI_POSIX: This is set to _POSIX_VERSION platforms that are mostly-compliant with POSIX.