Typedefs#

Type of the omniCarbShutdown function that is generated by OMNI_MODULE_DEFINE_CARB_FUNCTIONS .

Type of the omniCarbStartup function that is generated by OMNI_MODULE_DEFINE_CARB_FUNCTIONS .

Base type for the Omni core startup flags.

Callback that is called when a candidate plugin file is located.

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

Load Hook function.

A handle type for Framework::addLoadHook() and Framework::removeLoadHook()

Register Hook function.

A handle type for Framework::addRegisterHook() and Framework::removeRegisterHook()

Release Hook function.

An object can inherit from this class in order to use Carbonite allocation functions for creation/deletion.

Base type for the flags that control the behavior of CARB_ASSERT() and CARB_CHECK() failure reporting.

The hash must be a strong (not necessarily cryptographically secure) 128-bit hash.

Loader function (member of LoaderDesc ) that informs the asset type that loading a file has started and creates any load-specific context data necessary.

Loader function (member of LoaderDesc ) that returns a string of the asset dependencies, that is, other files to watch for changes.

Loader function (member of LoaderDesc ) that copies a LoadParameters structure.

Loader function (member of LoaderDesc ) that destroys the data created by CreateContextFn .

Loader function (member of LoaderDesc ) that cleans up the previously returned value from CreateDependenciesFn .

Loader function (member of LoaderDesc ) that destroys a copied LoadParameters structure.

Loader function (member of LoaderDesc ) that hashes an asset's data, this is used to combine collisions in the asset system.

Loader function (member of LoaderDesc ) that hashes a LoadParameters structure.

C++ Type hash used to identify a C++ type. Typically a hash of a type name string.

An Asset ID, used to identify a particular asset.

Determines if a currently processed load has been canceled.

Loader function (member of LoaderDesc ) used to construct an asset from raw data.

Loader function (member of LoaderDesc ) that determines if two LoadParameters derivatives are equal.

Function to provide as a callback on asset changes.

Loader function (member of LoaderDesc ) that is called when a dependency changes.

An Asset Pool, used to group assets together.

A snapshot, representing asset data at a given point in time.

Loader function (member of LoaderDesc ) used to unload an asset.

Alias for a counting semaphore that can only be acquired by one caller at a time.

A monotonic high-resolution clock.

Helper for carb::cpp::invoke_result which accesses the type member.

Helper type for remove_cvref .

basic_string_view<char>

Helper type for type_identity .

basic_string_view<char16_t>

basic_string_view<char32_t>

basic_string_view<wchar_t>

An abstraction for the lowest level file handle for the given operating system.

Registration identifier for a single metadata value.

Prototype for a callback function that is performed any time a dump is successfully uploaded.

Prototype for a callback that indicates when a crash dump upload has completed.

Metadata value callback function prototype.

Metadata value callback function prototype.

Metadata value callback function prototype.

Metadata value callback function prototype.

Metadata value callback function prototype.

Metadata value callback function prototype.

Prototype for a callback function used to resolve symbol information.

Definition helper for RefFromDelegate<Del>::type

Flags for deserializing a string (for ISerializer::createDictionaryFromStringBuffer() )

Prototype for a callback function used to walk items in a dictionary.

A callback that, once registered with IDictionary::subscribeToNodeChangeEvents() , receives notifications when an item at a specific path changes state or value.

A callback that, once registered with IDictionary::subscribeToTreeChangeEvents() , receives notifications when Items in a given tree change state or value.

Callback function that will tell whether and how the merger in IDictionary::update() operations should overwrite the destination item with the source item.

Base type for flags for the ISerializer::createStringBufferFromDictionary() function.

Callback function called when an observer is terminated with IEventDispatcher::stopObserving() . Typically not manually used as it is generated by IEventDispatcher::observeEvent() .

A type defined as carb::ObjectPtr<IMessageQueue> .

A handle to an observer, registered with IEventDispatcher::observeEvent() .

Callback function called when an event is dispatched. Typically not manually used as it is generated by IEventDispatcher::observeEvent() .

A type for the order value passed to various IEventDispatcher functions.

Event type is 64-bit number.

Helper definition for IEventListener smart pointer.

Helper definition for IEvent smart pointer.

Helper definition for IEventStream smart pointer.

Helper definition for ISubscription smart pointer.

Event notification order.

Event sender identifier.

Callback function called by IEventStream::walkSubscriptionsToPush and IEventStream::walkSubscriptionsToPop .

The decayed type of errno

Base type for the flags to control how libraries are loaded.

Handle to a loaded library.

Deprecated: Use HandleRef instead.

(Windows only) The type of value returned from GetLastError()

Base type for flags for the IFileSystem::makeCanonicalPathEx2() function.

Flag type for FindFilesArgs .

Callback invoked when a file matches a pattern matchWildcards and excludeWildcards.

Callback for each encountered file invoked before canonicalization and pattern matching.

Callback invoked when a file matches a pattern matchWildcards and does not match a pattern in excludeWildcards.

Callback invoked when starting a search in one of the given search paths.

Callback invoked when a file matches does not match a pattern in matchWildcards.

Defines the callback function to use when listening to changes on file system.

Type definition of a subscription.

A handle to an ActionMappingSet . A nullptr value represents an invalid ActionMappingSet .

Defines event type mask.

Callback function type for filtering events.

Defines input code type.

Function type that describes keyboard event callback.

Function type that describes gamepad connection event callback.

Function type that describes gamepad event callback.

Function type that describes input event callback.

Function type that describes keyboard event callback.

Function type that describes mouse event callback.

Type used as an identifier for all subscriptions.

Subscription order.

The return type for IL10n::getHashFromKeyString() .

The entry point to getLocalizedStringFromHash().

Prototype for a callback function used to check if a setting should be added.

Base type for a process exit code.

Process kill flags.

Launcher flags.

Prototype for a stream read callback function.

Base type for the identifier of a process.

Base type for the flags used when adding a settings tree to an argument collector object.

Stream waiting flags.

Base type for the flags that control how extra fields on log messages are managed.

Base type for the flags that indicate which log destinations are currently active.

Function pointer typedef for a logging function.

Defines a callback type for setting log level for every source.

The 128-bit signed integer type.

The 128-bit unsigned integer type.

Prototype of a parser function to handle a single option.

The type for a process ID.

ID for a GPU context created with IProfiler::createGpuContext .

ID for a Lockable context created with IProfiler::createLockable .

A callback used for IProfiler::setMaskCallback() . Typically handled automatically by carb::profiler::registerProfilerForClient() .

An opaque pointer used by IProfileMonitor .

A type representing a static string returned by IProfiler::registerStaticString() .

An opaque ID returned by IProfiler::beginStatic() / IProfiler::beginDynamic() that should be returned in IProfiler::endEx() to validate that the zone was closed properly.

Defines flags to be used in colorEdit3() / colorEdit4() / colorPicker3() / colorPicker4() / colorButton()

Defines flags to be used in simplegui::beginCombo()

Defines flags to be used in simplegui::dockSpace()

Defines flags to be used in simplegui::beginDragDropSource(), simplegui::acceptDragDropPayload()

Draw callbacks for advanced uses.

Defines DrawCornerFlags.

Defines flags to be used in simplegui::isWindowFocused()

Font enumeration function.

Defines flags to be used in simplegui::isItemHovered(), simplegui::isWindowHovered()

Defines input text flags for simplegui::inputText()

Defines item flags for simplegui::pushItemFlags().

Key modifiers returned by ISimpleGui::getKeyModifiers() .

Defines flags to be used in simplegui::selectable()

Defines flags to be used in simplegui::beginTabBar()

Defines flags to be used in simplegui::beginTabItem()

Definition of callback from InputText().

User data to identify a texture.

Defines tree node flags to be used in simplegui::collapsingHeader(), simplegui::treeNodeEx()

Flags stored in ImGuiViewport::Flags, giving indications to the platform back-ends.

SimpleGui-specific definition of a wide character.

Defines window flags for simplegui::begin()

The function executed by ITasking::applyRangeBatch()

The function executed by ITasking::applyRange()

Defines the function for performing a user-provided job.

The function to execute as a task.

Definition helper for RefFromDelegate<Del>::type

An opaque handle that is used with getTaskContext(), suspendTask() and wakeTask().

Callback function for ITasking::walkTaskDebugInfo() .

A destructor function for a Task Storage slot.

An opaque handle representing a Task Storage slot.

Each entry in the vector is a bitmask for a set of CPUs.

The type for a process ID.

A spinlock implementation that allows recursion.

Base type for flags to the task relay system.

Prototype for a relayed task function.

A spinlock implementation that does not allow recursion.

The type for a thread ID.

Alias for std::shared_lock .

Flags for token resolution algorithm.

Helper definition.

Helper definition.

Definition for callback on monitor change.

Definition for callback on window close.

Definition for callback on window content scale.

Definition for callback on window drop.

Definition for callback on window focus.

Definition for callback on window maximize.

Definition for callback on window minimize.

Definition for callback on window move.

Definition for callback on window resize.

Called to get dependencies from the module.

Typedef for API wrapper of ITypeFactory_abi .

Function called by ITypeFactory to instantiate an implementation.

Per omni::core::ModuleExportEntry flags.

Type of kModuleGetExportsName . See omniModuleGetExports .

Called to determine if the module can be unloaded.

Called during 'quick shutdown' when the module is unable to load and will be skipped.

Called to load interface implementation registration information.

This function will be called after the module is fully registered. It is called after omni::core::OnModuleLoadFn successfully returns.

Called when the module is about to be unloaded.

Error code for the result of an operation.

Base type for the flags used when registering plugins or implementations with the type factory. These are used to modify how the plugin or implementation is registered. No flags are currently defined. These flags will all have the prefix fTypeFactoryFlag .

Base type for an interface type identifier.

Typedef for API wrapper of IAffinityMask_abi .

Typedef for API wrapper of IJob_abi .

Typedef for API wrapper of IJobAffinity_abi .

Typedef for API wrapper of IJobWorker_abi .

Defines the function for performing a user-provided job.

Alias for an affinity mask.

A bit type for Extension Summary.

RAII pointer type.

RAII pointer type for IHookHolder .

Pointer type.

Pointer type.

Hook call order.

Custom equality functor for a case sensitive or insensitive map lookup.

Custom greater-than functor for a case sensitive or insensitive map lookup.

Custom hash functor for a case sensitive or insensitive hash based on the OS.

Custom less-than functor for a case sensitive or insensitive map lookup.

A map to store file paths and associated data according to local OS rules.

An unordered map to store file paths and associated data according to local OS rules.

RAII pointer type for IRunLoopRunner .

Base type for the display information flags.

Base type for the flags used in omni::platforminfo::IOsInfo2::getMachineId() .

Base type for the version numbers for the way that machine IDs are generated.

Base type for the display mode information flags.

Base type for a display mode index.

An object that refers to a contiguous sequence of objects.

Typedef for API wrapper of IReadOnlyCString_abi .

basic_string_view<char>

Base type for flags to control how new events are allocated.

Base type for the handle to an allocated block of memory returned from either the IStructuredLog::allocSchema() or IStructuredLog::allocEvent() functions.

Base type for flags to control how events and schemas are enabled or disabled.

Base type for flags to control the behavior of processing a single event.

Base type for a unique ID of a registered event.

Base type for flags that control how extra field flags are specified or retrieved in omni::structuredlog::IStructuredLogExtraFields::getExtraCloudEventField() and omni::structuredlog::IStructuredLogExtraFields::setExtraCloudEventField().

The prototype of the function to call when a validation error occurs.

The prototype of the function to call when a validation error occurs.

Base type for the ouptut flags for the structured logging system.

Base type for the version of the event payload parser to use.

Base type for the flags for that can be passed in the flags parameter to the omni::structuredlog::IStructuredLogSettings::loadPrivacySettingsFromFile() function.

Registration function to install a schema with the structured logging system.

Base type for flags to control the behavior of the handling of a schema as a whole.

Base type for a session ID.

String view for char strings.

basic_string_view<char16_t>

basic_string_view<char32_t>

basic_string_view<wchar_t>

Setting Flags type definition.