carb/PluginCoreUtils.h

↰ Parent directory: carb/

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

Source: carb/PluginCoreUtils.h

Included By

• carb/PluginUtils.h: Utilities to ease the creation of Carbonite plugins.

Namespaces

• omni: Main namespace for Omniverse.

• omni::core: Core functionality for Omniverse Interfaces.

• omni::log: Multi-channel logging.

Defines

• CARB_PLUGIN_IMPL_DEPS: Macros to declare a plugin implementation dependencies.

• CARB_PLUGIN_IMPL_MINIMAL: Macro to declare a “minimal” plugin.

• CARB_PLUGIN_IMPL_NO_DEPS: Macro to declare a plugin without dependencies.

• CARB_PLUGIN_IMPL_WITH_INIT: Defines boiler-plate code to declare the plugin’s interfaces and registration code.

• CARB_STATE: Macro to mark static and global variables to keep them when plugin is hotreloaded.

• OMNI_MODULE_GLOBALS_FOR_PLUGIN: Helper macro to declare globals needed by Carbonite plugins.

• OMNI_MODULE_SET_GLOBALS_FOR_PLUGIN: Populates the Omniverse interfaces portion of carb::PluginFrameworkDesc.

Variables

• kCarbGetFrameworkVersionFnName: See carb::GetFrameworkVersionFn. Required by plugins.

• kCarbGetPluginDepsFnName: See carb::GetPluginDepsFn. Optional for plugins.

• kCarbOnPluginPostShutdownFnName: See carb::OnPluginPostShutdownFn. Optional for plugins.

• kCarbOnPluginPreStartupFnName: See carb::OnPluginPreStartupFn. Optional for plugins.

• kCarbOnPluginQuickShutdownFnName: See carb::OnPluginQuickShutdownFn. Optional for plugins.

• kCarbOnPluginRegisterEx2FnName: See carb::OnPluginRegisterEx2Fn. Required by plugins.

• kCarbOnPluginRegisterExFnName: See carb::OnPluginRegisterExFn. Required by plugins.

• kCarbOnPluginRegisterFnName: See carb::OnPluginRegisterFn. Required by plugins.

• kCarbOnPluginShutdownFnName: See carb::OnPluginShutdownFn. Optional for plugins.

• kCarbOnPluginStartupExFnName: See carb::OnPluginStartupExFn. Optional for plugins.

• kCarbOnPluginStartupFnName: See carb::OnPluginStartupFn. Optional for plugins.

• kCarbOnReloadDependencyFnName: See carb::OnReloadDependencyFn. Optional for plugins.