carb/Types.h

↰ Parent directory: carb/

Common types used through-out Carbonite.

Source: carb/Types.h

Included By

• carb/Memory.h: DLL Boundary safe memory management functions.

• carb/Framework.h: Core header for registering and acquiring interfaces.

• carb/crashreporter/ICrashReporter.h: !

• carb/filesystem/IFileSystem.h: Carbonite FileSystem interface definition file.

• carb/assets/IAssets.h: Interface definition for carb.assets.plugin

• carb/audio/AudioTypes.h: Data types used by the audio interfaces.

• carb/profiler/IProfileMonitor.h: Monitor interface for carb::profiler.

• carb/simplegui/SimpleGuiTypes.h: carb::simplegui type definitions.

• omni/core/Types.h: Common data structs and types.

Namespaces

• carb: The main Carbonite namespace.

• omni: Main namespace for Omniverse.

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

• omni::log: Multi-channel logging.

• omni::structuredlog: Structured logging and Telemetry.

Classes

• carb::Color: RGBA color with templated data type.

• carb::ColorRgb: RGB float color.

• carb::ColorRgba: RGBA float color.

• carb::ColorRgbaDouble: RGBA double color.

• carb::ColorRgbDouble: RGB double color.

• carb::Double2: Two component double vector.

• carb::Double3: Three component double vector.

• carb::Double4: Four component double vector.

• carb::Float2: Two component float vector.

• carb::Float3: Three component float vector.

• carb::Float4: Four component float vector.

• carb::Int2: Two component int32_t vector.

• carb::Int3: Three component int32_t vector.

• carb::Int4: Four component int32_t vector.

• carb::PluginDesc: Defines a struct which contains all key information about a plugin loaded into memory.

• carb::PluginFrameworkDesc: Pass to each plugin’s carb::OnPluginRegisterExFn during load. Allows the plugin to grab global Carbonite state such as the carb::Framework singleton.

• carb::PluginImplDesc: Defines a descriptor for the plugin implementation, to be provided to the macro CARB_PLUGIN_IMPL.

• carb::PluginRegistryEntry: Defines a struct to be filled by a plugin to provide the framework with all information about it.

• carb::PluginRegistryEntry2: Defines a struct to be filled by a plugin to provide the framework with all information about it. This struct is automatically created and filled by the macro CARB_PLUGIN_IMPL.

• carb::SharedHandle: Defines a shared object handle.

• carb::Uint2: Two component uint32_t vector.

• carb::Uint3: Three component uint32_t vector.

• carb::Uint4: Four component uint32_t vector.

Enums

• carb::BindingType: An enum that describes a binding registration for carb::Framework::registerScriptBinding().

• carb::PluginHotReload: Defines the plugin hot reloading (auto reload) behaviour.

• carb::PluginReloadState: Lets clients of a plugin know both just before and just after that the plugin is being reloaded.

Defines

• CARB_MAKE_FOURCC: A macro for producing a carb::FourCC value from four characters.

Typedefs

• carb::FourCC: A representation that can combine four character codes into a single 32-bit value for quick comparison.

• carb::GetFrameworkVersionFn: Required. Returns the plugin’s required carb::Framework version.

• carb::GetPluginDepsFn: Optional. Returns a static list of interfaces this plugin depends upon.

• carb::LoadHookHandle: A handle type for Framework::addLoadHook() and Framework::removeLoadHook()

• carb::OnPluginPostShutdownFn: Optional. Called after carb::OnPluginShutdownFn.

• carb::OnPluginPreStartupFn: Optional. Called after carb::OnPluginRegisterExFn.

• carb::OnPluginQuickShutdownFn: Optional. Called if provided in lieu of OnPluginShutdownFn when the carb::quickReleaseFrameworkAndTerminate is performing a quick shutdown.

• carb::OnPluginRegisterEx2Fn: Either this or OnPluginRegisterEx2Fn or OnPluginRegisterFn are required. Populates the given carb::PluginRegistryEntry2 with the plugin’s information.

• carb::OnPluginRegisterExFn: Either this or OnPluginRegisterFn or OnPluginRegisterEx2 are required. Populates the given carb::PluginRegistryEntry with the plugin’s information.

• carb::OnPluginRegisterFn: Either this or OnPluginRegisterExFn or OnPluginRegisterEx2Fn are required. Populates the given carb::PluginRegistryEntry with the plugin’s information.

• carb::OnPluginShutdownFn: Optional. Called after carb::OnPluginStartupExFn.

• carb::OnPluginStartupExFn: Optional. Called after carb::OnPluginPreStartupFn.

• carb::OnPluginStartupFn: Optional. Called after carb::OnPluginPreStartupFn.

• carb::OnReloadDependencyFn: Optional.

Variables

• carb::kInvalidLoadHook: A value indicating an invalid load hook handle.

• carb::kTimeoutInfinite: Timeout constant.