omni/core/Omni.h

↰ Parent directory: omni/core/

Main header for the Omniverse core.

Source: omni/core/Omni.h

Included By

• carb/PluginCoreUtils.h: Utilities to ease the creation of Carbonite plugins. Most code will include carb/PluginUtils.h instead of this file.

• omni/core/OmniInit.h: Core header for starting the Omniverse core.

• omni/extras/UniqueApp.h: Helper class to manage a unique process.

Classes

• OmniCoreStartArgs: Arguments passed to omniCoreStart.

Functions

• omniCoreStart: Initializes the omni core library’s internal data structures.

• omniCoreStop: Tears down the omni core library’s internal data structures.

• omniGetModuleDirectory: Returns the module’s directory name (e.g. “c:/foo” for “c:/foo/omni-glfw.dll”). The pointer returned is valid for the lifetime of the module.

• omniGetModuleFilename: Returns the module’s name (e.g. “c:/foo/omni-glfw.dll”). The pointer returned is valid for the lifetime of the module.

• omniReleaseStructuredLog: Releases the structured log pointer.

Defines

• OMNI_APP_GLOBALS: Helper macro to declare globals needed my the omni library when using the omni library in an application.

• OMNI_CORE_START: Helper macro to startup the Carbonite framework and Omni type factory.

• OMNI_CORE_STOP: Helper macro to shutdown the Carbonite framework and Omni type factory.

• OMNI_GLOBALS_ADD_DEFAULT_CHANNEL: Adds the name_ as the default logging channel.

• OMNI_GLOBALS_ADD_DEFAULT_CHANNEL_1: Implementation detail. Do not directly use. Use OMNI_GLOBALS_ADD_DEFAULT_CHANNEL.

• OMNI_MODULE_DEFINE_LOCATION_FUNCTIONS: Defines functions centered around determining the current module’s disk location.

• OMNI_MODULE_DEFINE_OMNI_FUNCTIONS: Defines default implementations of global omni functions for a module.

• OMNI_MODULE_GLOBALS: Helper macro to declare globals needed by modules (i.e. plugins).

• OMNI_MODULE_GLOBALS_WITHOUT_CARB: Helper macro to declare globals needed by modules (i.e. plugins).

• OMNI_MODULE_SET_CARB_EXPORTS: Helper macro to set known export fields in omniModuleGetExports related to Carbonite.

• OMNI_MODULE_SET_EXPORTS: Helper macro to set known export fields in omniModuleGetExports.

• OMNI_MODULE_SET_EXPORTS_WITHOUT_CARB: Helper macro to set known export fields in omniModuleGetExports.

Typedefs

• OmniCoreStartFlags: Base type for the Omni core startup flags.

Variables

• fStartFlagDisableILog: Flag to indicate that ILog usage should be disabled on startup instead of creating the internal version or expecting that the caller to provide an implementation of the ILog interface that has already been instantiated.

• fStartFlagDisableIStructuredLog: Flag to indicate that IStructuredLog usage should be disabled on startup instead of creating the internal version or expecting that the caller to provide an implementation of the IStructuredLog interface that has already been instantiated.

• kOmniCoreStartArgsVersion: Version of OmniCoreStartArgs struct passed to omniCoreStart.