omni::kit::exec::core::unstable

namespace unstable

In-development interfaces for Kit’s integration with Execution Framework. Do not take dependencies on any code in this namespace.

Classes

• IClearCallback: Interface wrapping a callback (possibly with storage) called when omni::kit::exec::core::unstable::IExecutionControllerFactory::clear is executed.

• IClearCallback_abi: Interface wrapping a callback (possibly with storage) called when omni::kit::exec::core::unstable::IExecutionControllerFactory::clear is executed.

• IExecutionContext: omni::kit::exec::core::unstable::IExecutionContext inherits all of the functionality of omni::graph::exec::unstable::IExecutionContext but adds information related to Kit.

• IExecutionContext_abi: omni::kit::exec::core::unstable::IExecutionContext inherits all of the functionality of omni::graph::exec::unstable::IExecutionContext but adds information related to Kit.

• IExecutionController: omni::kit::exec::core::unstable::IExecutionController encapsulates a omni::graph::exec::unstable::IGraph which helps orchestrates part of the computation for one of Kit's UsdContext .

• IExecutionControllerFactory: Factory for creating instances of omni::kit::exec::core::unstable::IExecutionController .

• IExecutionControllerFactory_abi: Factory for creating instances of omni::kit::exec::core::unstable::IExecutionController .

• IExecutionController_abi: omni::kit::exec::core::unstable::IExecutionController encapsulates a omni::graph::exec::unstable::IGraph which helps orchestrates part of the computation for one of Kit's UsdContext .

• IExecutionGraphSettings: Interface for accessing global execution graph settings.

• IExecutionGraphSettings_abi: Interface for accessing global execution graph settings.

• ITbbSchedulerState: Returns a global scheduler state based on TBB.

• ITbbSchedulerState_abi: Returns a global scheduler state based on TBB.

Functions

• addClearCallback(Fn &&fn) noexcept: Adds a callback that will be invoked when omni::kit::exec::core::unstable::IExecutionControllerFactory::clear() is called.

• getDefaultExecutionController() noexcept: Returns the "default" omni::kit::exec::core::unstable::IExecutionController associated with the "default" UsdContext .

• getExecutionControllerFactory() noexcept: Returns the singleton omni::kit::exec::core::unstable::IExecutionControllerFactory .

• getExecutionGraphSettings() noexcept: Returns the omni::kit::exec::core::unstable::IExecutionGraphSettings singleton.

• getTbbSchedulerState() noexcept: Returns the singleton omni::kit::exec::core::unstable::ITbbSchedulerState .

• isDefaultExecutionControllerInExecute() noexcept: Convenience inlined method for determining whether the "default" omni::kit::exec::core::unstable::IExecutionController associated with the "default" UsdContext . is currently executing.

• removeClearCallbacks() noexcept: Removes any omni::kit::exec::core::unstable::IExecutionControllerFactory clear callback registered by the plugin/module. This method should not be explicitly called, rather call OMNI_KIT_EXEC_CORE_ON_MODULE_UNLOAD during plugin/module shutdown.

Namespaces

• detail

Structs

• ExecutionContextTime: ABI-safe struct containing time information for graph execution.

• ParallelSpawner: Interface executors use to talk to the scheduler. Every executor object that wishes to use the ParallelScheduler (which is a singleton) will have its own associated instance of ParallelSpawner .

• TbbSchedulerState: Implementation details for the TBB based task scheduler state singleton.

Typedefs

• ClearCallbackPtr: Smart pointer managing an instance of IClearCallback .

• ExecutionControllerFactoryPtr: Smart pointer for omni::kit::exec::core::unstable::IExecutionControllerFactory .

• ExecutionControllerPtr: Smart pointer for omni::kit::exec::core::unstable::IExecutionController .