kit#

Fully qualified name: omni::kit

namespace kit#: Namespace for kit.

Classes#

IApp: Main Kit Application plugin.
IAppMessageBox: Interface for producing an OS-specific modal message box.
IAppScripting: Scripting Engine interface.
IRunLoopRunner: Interface to implement by custom run loop runners.
RunLoop: Run Loop.

Enumerations#

MessageBoxButtons: Buttons to place on the message box.
MessageBoxResponse: Message box user response.
MessageBoxType: Message box type.
RestartArgsPolicy: How to handle passed arguments when restarting an app.

Namespaces#

update: Namespace for kit update ordering values.

Structs#

AppDesc: Application descriptor.
AppInfo: App information.
BuildInfo: Build information.
PlatformInfo: Platform information.

Typedefs#

IRunLoopRunnerPtr: RAII pointer type for IRunLoopRunner .

Variables#

const carb::events::EventType kEventAppReady: Legacy version of kGlobalEventAppReady .
const carb::events::EventType kEventAppStarted: Legacy version of kGlobalEventAppStarted .
const auto kGlobalEventAppReady: An event that is dispatched when the application becomes ready.
const auto kGlobalEventAppStarted: An event that is dispatched at app startup time.
const auto kGlobalEventErrorLog: An event that is dispatched for each error log emitted.
const auto kGlobalEventErrorLogImmediate: An event that is dispatched for each error log emitted (immediate).
const auto kGlobalEventPostQuit: A shutdown event that is dispatched during the next update after postQuit is called.
const auto kGlobalEventPostUpdate: The final update event that is dispatched during the main RunLoop frame.
const auto kGlobalEventPreShutdown: A shutdown event that is dispatched to indicate the start of shutdown.
const auto kGlobalEventPreUpdate: The first early event that is dispatched at the beginning of the main RunLoop frame.
const auto kGlobalEventScriptingCommand: An event that is dispatched when a scripting command is issued (update).
const auto kGlobalEventScriptingCommandImmediate: An event that is dispatched when a scripting command is issued (immediate).
const auto kGlobalEventScriptingStdErr: An event that is dispatched when python prints to stderr (update).
const auto kGlobalEventScriptingStdErrImmediate: An event that is dispatched when python prints to stderr (immediate).
const auto kGlobalEventScriptingStdOut: An event that is dispatched when python prints to stdout (update).
const auto kGlobalEventScriptingStdOutImmediate: An event that is dispatched when python prints to stdout (immediate).
const auto kGlobalEventUpdate: The main update event that is dispatched during the main RunLoop frame.
constexpr carb::events::EventType kPostQuitEventType: Legacy version of kGlobalEventPostQuit .
constexpr carb::events::EventType kPreShutdownEventType: Legacy version of kGlobalEventPreShutdown .
constexpr char kRunLoopDefault: Predefined Run Loop name.
constexpr char kRunLoopRendering: Predefined Run Loop name.
constexpr char kRunLoopSimulation: Predefined Run Loop name.
constexpr char kRunLoopUi: Predefined Run Loop name.
const carb::events::EventType kScriptingEventCommand: Legacy version of kGlobalEventScriptingCommand .
const carb::events::EventType kScriptingEventStdErr: Legacy version of kGlobalEventScriptingCommand .
const carb::events::EventType kScriptingEventStdOut: Legacy version of kGlobalEventScriptingCommand .