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

Namespaces

  • omni: Main namespace for Omniverse.

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

  • omni::log: Multi-channel logging.

Functions

  • carbGetFrameworkVersion: An automatically-generated function exported by Carbonite plugins used to check the plugin’s Framework compatibility.

  • carbGetPluginDeps: An automatically-generated function exported by some Carbonite plugins.

  • carbOnPluginPostShutdown: An automatically-generated function exported by Carbonite plugins.

  • carbOnPluginPreStartup: An automatically-generated function exported by Carbonite plugins.

  • carbOnPluginQuickShutdown: An optional function that a plugin author can export from their plugin to quick-shutdown their plugin.

  • carbOnPluginRegister: An automatically-generated function exported by some Carbonite plugins (now deprecated).

  • carbOnPluginRegisterEx: An automatically-generated function exported by some Carbonite plugins (now deprecated).

  • carbOnPluginRegisterEx2: An automatically-generated function exported by some Carbonite plugins.

  • carbOnPluginShutdown: An optional function that a plugin author can export from their plugin to shutdown their plugin.

  • carbOnPluginStartup: An optional function that a plugin author can export from their plugin to start their plugin.

  • carbOnPluginStartupEx: An optional function that a plugin author can export from their plugin to start their plugin.

  • carbOnReloadDependency: An optional function that a plugin author can export from their plugin to receive dependency reload notifications.

Defines

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