OMNI_COMPILE_FLAGS
MACRO

OMNI_COMPILE_FLAGS - If defined, builds in the omni/defs/compile_flags.hpp header

SYNOPSIS top

Defining this macro will build the omni/defs/compile_flags.hpp file into the framework.

DESCRIPTION top

The omni/defs/compile_flags.hpp header file contains constant extern values that can be used at run time to determine compile time flags.

The compile_flags header is mostly for debug purposes and certain validations and is not explicitly used anywhere in the framework; which is why you must explicitly define this compile time macro.

CONSIDERATIONS top

Specifying this flag will bake the compile flags into the binary built for Omni (either direct user code or a library file like a .a or .lib). While useful for debugging, anyone attempting to reverse engineer your code can also see these flags in the binary, thus making it slightly easier for them to determine how a binary can operate, as well, it also bloats the size of the binary file (since you have directly included the compile values as variables).

PLATFORM SPECIFIC top

No platform specific notes.

NOTES top

It should be stressed that this flag is specifically to enable building compile time constants into the run time binary for debugging purposes.