ModuleExports.h¶

↰ Parent directory: omni/core/

Helpers for defining a plugin’s omni::core::ModuleExports table.

Source: omni/core/ModuleExports.h

Namespaces¶

carb: The main Carbonite namespace.
carb::assert: Namespace for all assertion checking helpers and interfaces.
carb::l10n: Utilities for localizing text.
carb::logging: Undocumented.
carb::profiler: Namespace for carb.profiler and related utilities.
omni: Main namespace for Omniverse.
omni::core: Core functionality for Omniverse Interfaces.
omni::log: Multi-channel logging.
omni::structuredlog: Structured logging and Telemetry.

Classes¶

omni::core::ModuleExportEntry: Define an entry in omni::core::ModuleExports.
omni::core::ModuleExportEntryCarbClientName: omni::core::ModuleExports entry to interop wht g_carbClientName.
omni::core::ModuleExportEntryCarbFramework: omni::core::ModuleExports entry to interop with carb::Framework.
omni::core::ModuleExportEntryCarbIAssert: omni::core::ModuleExports entry to interop with carb::assert::IAssert.
omni::core::ModuleExportEntryCarbIL10n: omni::core::ModuleExports entry to interop with carb::l10n::IL10n.
omni::core::ModuleExportEntryCarbILogging: omni::core::ModuleExports entry to interop with carb::logging::ILogging.
omni::core::ModuleExportEntryCarbIProfiler: omni::core::ModuleExports entry to interop with carb::profiler::IProfiler.
omni::core::ModuleExportEntryGetModuleDependencies: omni::core::ModuleExports entry to register a function to advertise the interface implementations available in the plugin.
omni::core::ModuleExportEntryILog: omni::core::ModuleExports entry to access omni::log::ILog.
omni::core::ModuleExportEntryIStructuredLog: omni::core::ModuleExports entry to access omni::structuredlog::IStructuredLog.
omni::core::ModuleExportEntryITypeFactory: Forward declaration for omni::core::ITypeFactory.
omni::core::ModuleExportEntryLogChannel: omni::core::ModuleExports entry to add a logging channel.
omni::core::ModuleExportEntryOnModuleCanUnload: omni::core::ModuleExports entry to register a function to determine if the module can be unloaded.
omni::core::ModuleExportEntryOnModuleLoad: omni::core::ModuleExports entry to register a function to advertise the interface implementations available in the plugin.
omni::core::ModuleExportEntryOnModuleStarted: omni::core::ModuleExports entry to register a function to be called after the plugin has loaded.
omni::core::ModuleExportEntryOnModuleUnload: omni::core::ModuleExports entry to register a function to be called when the plugin is unloaded.
omni::core::ModuleExportEntrySchema: omni::core::ModuleExports entry to add a new structured logging schema to be registered.
omni::core::ModuleExports: Entities exported by a module for both use and population by omni::core::ITypeFactory.

Functions¶

omniModuleGetExports: Main entry point into a module. Returns the list of capabilities and requirements for the module.

Defines¶

OMNI_MODULE_ADD_LOG_CHANNEL: Adds a log channel to the logging system. The channel will be removed when the module is unloaded.
OMNI_MODULE_ADD_STRUCTURED_LOG_SCHEMA: adds a new schema to be registered after core startup.
OMNI_MODULE_EXPORT_ENTRY_BEGIN: Helper macro for defining an entry (i.e. omni::core::ModuleExportEntry) in the export table (i.e. omni::core::ModuleExports).
OMNI_MODULE_EXPORT_ENTRY_END: Helper macro for defining an entry in the export table.
OMNI_MODULE_GET_MODULE_DEPENDENCIES: Registers the function responsible for advertising the plugin’s interface dependencies.
OMNI_MODULE_ON_MODULE_CAN_UNLOAD: Registers the plugin’s function that determines if the plugin can be unloaded. See omni::core::OnModuleCanUnloadFn for details.
OMNI_MODULE_ON_MODULE_LOAD: Registers the plugin’s function who is responsible for advertising the available interface implementations in the plugin.
OMNI_MODULE_ON_MODULE_STARTED: Registers the plugin’s function that will be called once the plugin is loaded. See omni::core::OnModuleStartedFn for threading consideration with this function.
OMNI_MODULE_ON_MODULE_UNLOAD: Registers the plugin’s function who is responsible for cleaning up the plugin when the plugin is being unloaded.
OMNI_MODULE_REQUIRE_CARB_CLIENT_NAME: Requires that the owning omni::core::ITypeFactory provides a Carbonite client name: g_carbClientName.
OMNI_MODULE_REQUIRE_CARB_FRAMEWORK: Requires that the owning omni::core::ITypeFactory provides a Carbonite carb::Framework g_carbFramework.
OMNI_MODULE_REQUIRE_CARB_IASSERT: Requires that the owning omni::core::ITypeFactory provides a Carbonite carb::assert::IAssert g_carbAssert.
OMNI_MODULE_REQUIRE_CARB_IL10N: Requires that the owning omni::core::ITypeFactory provides a Carbonite carb::l10n::IL10n g_carbLocalization.
OMNI_MODULE_REQUIRE_CARB_ILOGGING: Requires that the owning omni::core::ITypeFactory provides a Carbonite carb::logging::ILogging g_carbLogging.
OMNI_MODULE_REQUIRE_CARB_IPROFILER: Requires that the owning omni::core::ITypeFactory provides a Carbonite carb::profiler::IProfiler g_carbProfiler.

Typedefs¶

omni::core::GetModuleDependeciesFn: Called to get depencies from the module.
omni::core::ModuleExportEntryFlag: Per omni::core::ModuleExportEntry flags.
omni::core::ModuleGetExportsFn: Type of omni::core::kModuleGetExportsName. See omniModuleGetExports.
omni::core::OnModuleCanUnloadFn: Called to determine if the module can be unloaded.
omni::core::OnModuleLoadFn: Called to load interface implementation registration information.
omni::core::OnModuleStartedFn: This function will be called after the module is fully registered. It is called after omni::core::OnModuleLoadFn successfully returns.
omni::core::OnModuleUnloadFn: Called when the module is about to be unloaded.
omni::structuredlog::SchemaAddFn: Registration function to install a schema with the structured logging system.

Variables¶

omni::core::fModuleExportEntryFlagNone: No flags.
omni::core::fModuleExportEntryFlagRequired: Fail module load if entry could not be populated.
omni::core::kModuleExportEntryTypeCarbClientName: Unique type name for omni::core::ModuleExportEntryCarbClientName.
omni::core::kModuleExportEntryTypeCarbFramework: Unique type name for omni::core::ModuleExportEntryCarbFramework.
omni::core::kModuleExportEntryTypeCarbIAssert: Unique type name for omni::core::ModuleExportEntryCarbIAssert.
omni::core::kModuleExportEntryTypeCarbIL10n: Unique type name for omni::core::ModuleExportEntryCarbIL10n.
omni::core::kModuleExportEntryTypeCarbILogging: Unique type name for omni::core::ModuleExportEntryCarbILogging.
omni::core::kModuleExportEntryTypeCarbIProfiler: Unique type name for omni::core::ModuleExportEntryCarbIProfiler.
omni::core::kModuleExportEntryTypeGetModuleDependencies: Unique type name for omni::core::ModuleExportEntryGetModuleDependencies.
omni::core::kModuleExportEntryTypeILog: Unique type name for omni::core::ModuleExportEntryILog.
omni::core::kModuleExportEntryTypeIStructuredLog: Unique type name for omni::core::ModuleExportEntryIStructuredLog.
omni::core::kModuleExportEntryTypeITypeFactory: Unique type name for omni::core::ModuleExportEntryITypeFactory.
omni::core::kModuleExportEntryTypeLogChannel: Unique type name for omni::core::ModuleExportEntryLogChannel.
omni::core::kModuleExportEntryTypeOnModuleCanUnload: Unique type name for omni::core::ModuleExportEntryOnModuleCanUnload.
omni::core::kModuleExportEntryTypeOnModuleLoad: Unique type name for omni::core::ModuleExportEntryOnModuleLoad.
omni::core::kModuleExportEntryTypeOnModuleStarted: Unique type name for omni::core::ModuleExportEntryOnModuleStarted.
omni::core::kModuleExportEntryTypeOnModuleUnload: Unique type name for omni::core::ModuleExportEntryOnModuleUnload.
omni::core::kModuleExportEntryTypeSchema: Unique type name for omni::core::ModuleExportEntrySchema.
omni::core::kModuleExportsMagic: Magic number for sanity checking of omni::core::ModuleExports.
omni::core::kModuleExportsVersion: Binary layout of omni::core::ModuleExports. This should be incremented if the fields in omni::core::ModuleExports change.
omni::core::kModuleGetExportsName: Name of the module’s exported function that is of type omni::core::ModuleGetExportsFn. See omniModuleGetExports.