Classes#

Arguments passed to omniCoreStart() .

A class implementing the ' Allocator ' C++ Named Requirement.

Allocated object deleter helper class.

Attempts to invoke the Empty Member Optimization by inheriting from the First element if possible, which, if empty will eliminate the storage necessary for an empty class; the Second element is always stored as a separate member. The First element is inherited from if it is an empty class / struct and is not declared final .

A class that manages subscribers.

A helper class used by CARB_BINDINGS() to acquire and release the Framework for a binding.

Reference-counted object base.

Smart pointer type for ref counting IObject .

Carbonite registered strings.

A registered string key.

Case-insensitive registered string.

A case-insensitive registered string key.

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

A scoped snapshot, this automatically releases the snapshot when it goes out of scope.

Static class for a CPU time-stamp clock.

Lock-Free Asynchronous Buffer Supports only 1 producer, 1 consumer.

IntrusiveList is very similar to std::list, but requires the tracking information to be contained within the stored type T , rather than built around it.

Defines a "link node" that IntrusiveList will use for tracking data for the contained type.

IntrusiveUnorderedMultimap is a closed-addressing hash table very similar to std::unordered_multimap, but requires the tracking information to be contained within the stored type T , rather than built around it.

Defines a "link node" that IntrusiveUnorderedMultimap will use for tracking data for the contained type.

Implements a lockless queue: a FIFO queue that is thread-safe yet requires no kernel synchronization.

Defines the link object.

Implements a lockless stack: a LIFO container that is thread-safe yet requires no kernel involvement.

Defines the link object.

Implements an Unordered Map, that is: a container that contains a mapping of keys to values where all keys must be unique.

Implements an Unordered Multimap, that is: a container that contains a mapping of keys to values where keys may be inserted multiple times, each creating a new element.

Implements an Unordered Multimap, that is: a container that contains a set of keys where keys may be inserted multiple times, each creating a new element.

Implements an Unordered Set, that is: a container that contains a set of keys that all must be unique.

Implements a "Robin Hood" open-addressing hash container that can either store keys alone or key/value pairs; this template is not meant to be used directly instead use RHUnorderedSet , RHUnorderedMap , RHUnorderedMultimap , or RHUnorderedMultiset .

Exception object identifying that an invalid use of an optional object was made.

Implements a C++20 barrier in C++14 semantics.

The class template basic_string_view describes an object that can refer to a constant contiguous sequence of elements with the first element of the sequence at position zero.

C++20-compatible counting semaphore class.

Implements a C++20 latch in C++14 semantics.

Template class to identify an optional value.

An object that refers to a contiguous sequence of objects.

Implements a thread-safe callback system that can have multiple subscribers.

Holds a reference to a Delegate .

Base class for carb::delegate::Delegate .

The base class for all registered string classes: RString , RStringU , RStringKey , and RStringUKey .

A helper class for calling readLock() and unlock().

A helper class for calling writeLock() and unlock().

A presentation class for EventData . Allows querying the data via a simple C++ interface.

An instance of a message queue.

Structure to manage the lifetime of an observer. Similar to std::unique_ptr .

Event object which is sent and received.

Interface to implement for event listener.

Event stream is fundamental primitive used to send, receive and listen for events.

Interface for creating IEventStream objects that adapt IEventStream functionality to carb::eventdispatcher systems.

Subscription holder is created by all event listening subscription functions.

A helper to use a std::function as an carb::events::IEventListener .

Encoder and decoder helper for Base64 data.

Helper class for gathering and querying CPU information for x86 and x64 CPUs.

Defines an environment variable class that allows one to get, set, and restore value on destruction.

Parses environment variables into program options or environment variables.

Provides an OS-style mapping of a Handle to a Resource.

Path objects are used for filesystem path manipulations.

A utility helper class to provide shared memory access to one or more processes.

A simple iterator class for walking a UTF-8 string.

Static helper class to allow for the processing of UTF-8 strings.

UUIDv4 Unique Identifier (RFC 4122)

A type representing a set of action mappings.

A RAII class for holding a read lock over multiple operations.

A RAII class for holding a write lock over multiple operations.

A simple child process argument collector helper class.

A simple environment variable collector helper class.

A class that pauses logging to a file when constructed and resumes logging to a file when destroyed.

A RAII object for overriding a thread's log level for a given type in StandardLogger while in scope.

A sub-interface of ILogging for StandardLogger instances.

An allocator that initially allocates from a memory arena (typically on the stack) and falls back to another allocator when that is exhausted.

Receives the results of parsing an options string.

A multi-value type.

Profiler channel which can be configured via carb::settings::ISettings .

Helper class that allows to automatically stop profiling upon leaving block.

Helper class that allows to automatically stop profiling upon leaving block.

Wrapper to add automatic profiling to a mutex.

Wrapper to add automatic profiling to a shared mutex.

A scoped object that attempts to acquire the Python Global Interpreter Lock (GIL) upon construction, and releases the GIL upon destruction.

Allows limited control over Python threading aspects without causing Python to be loaded in the process or requiring direct knowledge of Python.

A scoped object that attempts to completely release the Python Global Interpreter Lock (GIL) if held by the current thread, allowing other threads to make progress in the Python interpreter.

A helper class for performing a scoped read lock on the settings database.

Helper class to add a setting node or tree change subscription that will be automatically unregistered when the object goes out of scope.

A helper class for performing a scoped write lock on the settings database.

A utility for caching a setting and automatically subscribing to changes of the value, as opposed to constantly polling.

A fiber-aware condition_variable: a synchronization primitive that, together with a Mutex , blocks one or more threads or tasks until a condition becomes true.

Wrapper for carb::tasking::ConditionVariable .

Used to create dependencies between tasks and to wait for a set of tasks to finish.

Wrapper for a carb::tasking::Counter .

Implements a task-aware, task-safe callback system that can have multiple subscribers.

Holds a reference to a Delegate .

A Future is a counterpart to a Promise .

A fiber-aware mutex: a synchronization primitive for mutual exclusion.

Wrapper for a carb::tasking::Mutex that conforms to C++ Named Requirements of Lockable .

Causes the currently executing TaskContext to be "pinned" to the thread it is currently running on until PinGuard is destroyed.

A facility to store a value that is later acquired asynchronously via a Future created via Promise::get_future() .

Wrapper for a recursive carb::tasking::Mutex that conforms to C++ Named Requirements of Lockable .

When instantiated, begins tracking the passed Trackers .

A fiber-aware semaphore: a synchronization primitive that limits to N threads/fibers.

Wrapper for a carb::tasking::Semaphore .

SharedFuture is a shareable version of Future .

A fiber-aware shared_mutex: a synchronization primitive that functions as a multiple-reader/single-writer lock.

Wrapper for a carb::tasking::SharedMutex that (mostly) conforms to C++ Named Requirements of SharedMutex .

An empty type used to invoke splitting constructors.

TaskGroup is a small and fast counter for tasks.

Opaque handle for a thread pool.

Helper class for using IThreadPool API.

A utility class for providing a growing number of pause instructions, followed by yielding.

Base template.

A class for declaring a dynamic thread-local variable (Large/Non-trivial specialization).

A class for declaring a dynamic thread-local variable (Trivial/Pointer/POD specialization).

Spinlock and RecursiveSpinlock are locking primitives that never enter the kernel to wait.

A Carbonite implementation of std::mutex .

A Carbonite implementation of std::recursive_mutex .

A recursive shared mutex.

A shared mutex implementation conforming to C++17's shared_mutex .

Lifetime management wrapper for IVariant::registerType() .

A wrapper class for managing the lifetime of VariantData and converting the contained value to C++ types.

An array-of-variants type that can itself be contained in a Variant .

An associative array (i.e.

The API layer of an Omniverse interface.

Implements the generated API layer for omni::core::ITypeFactory

Templated class to store generated code from the omni.bind code generator.

Base class for all.

A mapping from type id's to implementations.

Control block to maintain weak and strong reference counts for an object.

Interface defining a contract for objects which support "weak"/non-owning references.

Interface for providing a CPU affinity mask to the plugin.

Interface for setting CPU affinity for the job system.

Interface for managing the number of workers in the job system.

Basic interface for launching jobs on a foreign job system.

Information about an extension.

Hooks that can be defined by plugins to better understand how the plugin is being used by the extension system.

Read-only object to encapsulate a channel filter's pattern and effects.

Consumes (listens for) state change to one or more omni::log::ILog objects.

Consumes (listens for) log messages.

Consumes (listens for) log messages.

Multi-channel logging interface which can write logs to multiple consumers.

Interface to collect CPU information directly from Linux's root level control group.

Interface to collect memory information directly from Linux's root control group.

Interface to collect information about the CPUs installed in the calling system.

Interface to collect and retrieve information about displays attached to the system.

Interface to collect information about the CPUs installed in the calling system.

Interface to collect and retrieve information about memory installed in the system.

Interface to collect and retrieve information about memory installed in the system.

Extended interface to collect and retrieve more information about the operating system.

Interface to collect and retrieve information about the operating system.

Reference counted read-only C-style (i.e. null-terminated) string.

Interface for the second version of the IStructuredLogControl interface.

Structured log state control interface.

Interface to manage extra CloudEvent fields to be included in each emitted message.

This interface controls the ability to send Carbonite and Omniverse logging through the structured log system.

Interface for the second version of the IStructuredLogSettings interface.

Interface for the third version of the IStructuredLogSettings interface.

Structured log settings interface.

Main structured log interface.

Base class for all.

Base class for all.

A mapping from type id's to implementations.

Interface defining a contract for objects which support "weak"/non-owning references.

Control block to maintain weak and strong reference counts for an object.

Control block to maintain weak and strong reference counts for an object.

Interface defining a contract for objects which support "weak"/non-owning references.

Helper template for interface inheritance.

Helper object used by omni.bind to ease, at zero cost, the acceptance of raw and smart pointers to methods that wish to accept a raw pointer.

Smart pointer wrapper around interface pointers.

Exception object that encapsulates a Result along with a customizable message.

Arguments passed to omniCreateTypeFactory() .

Weak pointer to ONI objects much like std::weak_ptr .

This iterator adapter wraps a pointer type into a class. It does not change the semantics of any operations from the fundamental logic of pointers. There are no bounds checks, there is no additional safety.

A monad which holds either an expected value (the success case) or an unexpected value (the error case).

Interface for providing a CPU affinity mask to the plugin.

Interface for setting CPU affinity for the job system.

Interface for managing the number of workers in the job system.

Basic interface for launching jobs on a foreign job system.

The manager class that is responsible for all Extensions.

A wrapper object to allow passing an invocable type (i.e.

Extension plugin interface.

Information about an extension.

Hooks that can be defined by plugins to better understand how the plugin is being used by the extension system.

Extension manager subclass with all the hooks that can be installed into it.

An interface that can be implemented to receive extension state changes.

Hook holder.

Interface to be implemented to add new extension path protocols.

Interface to be implemented by registry providers.

Helper class to force the linking of a C++ symbol.

Static helper class to provide standardized access to the telemetry privacy setting values.

A templated helper class to provide a simple resizable scratch buffer.

Helper class to manage a unique app.

A polymorphic function wrapper which is compatible with std::function .

Main Kit Application plugin.

Interface for producing an OS-specific modal message box.

Scripting Engine interface.

Interface to implement by custom run loop runners.

Run Loop.

Multi-channel logging interface which can write logs to multiple consumers.

Read-only object to encapsulate a channel filter's pattern and effects.

Read-only object to encapsulate a channel filter's pattern and effects.

Consumes (listens for) state change to one or more omni::log::ILog objects.

Consumes (listens for) state change to one or more omni::log::ILog objects.

Consumes (listens for) log messages.

Consumes (listens for) log messages.

Consumes (listens for) log messages.

Consumes (listens for) log messages.

Multi-channel logging interface which can write logs to multiple consumers.

A move-only function wrapper that can store and invoke callable objects.

Interface to collect CPU information directly from Linux's root level control group.

Interface to collect CPU information directly from Linux's root level control group.

Interface to collect memory information directly from Linux's root control group.

Interface to collect memory information directly from Linux's root control group.

Interface to collect information about the CPUs installed in the calling system.

Interface to collect information about the CPUs installed in the calling system.

Interface to collect and retrieve information about displays attached to the system.

Interface to collect and retrieve information about displays attached to the system.

Interface to collect information about the CPUs installed in the calling system.

Interface to collect information about the CPUs installed in the calling system.

Interface to collect and retrieve information about memory installed in the system.

Interface to collect and retrieve information about memory installed in the system.

Interface to collect and retrieve information about memory installed in the system.

Interface to collect and retrieve information about memory installed in the system.

Interface to collect and retrieve information about the operating system.

Extended interface to collect and retrieve more information about the operating system.

Extended interface to collect and retrieve more information about the operating system.

Interface to collect and retrieve information about the operating system.

pybind11 "holder" for objects inherited from omni::core::ObjectPtr .

Reference counted read-only C-style (i.e. null-terminated) string.

Concrete implementation of the IReadOnlyCString interface.

This class is an ABI safe string implementation.

A memory allocator interface, which can be overwritten with your custom allocator.

An extension of carb::cpp::basic_string_view that can handle nullptr and std::basic_string as inputs.

A helper class to calculate the required size of a binary blob.

A class to read binary blobs produced by the BlobWriter .

A class to build a binary blob.

An implementation of Allocator which will just allocate from a preallocated block of memory and never deallocate memory until the full preallocated block is freed.

Main structured log interface.

Structured log state control interface.

Interface for the second version of the IStructuredLogControl interface.

Interface for the second version of the IStructuredLogControl interface.

Structured log state control interface.

Interface to manage extra CloudEvent fields to be included in each emitted message.

Interface to manage extra CloudEvent fields to be included in each emitted message.

This interface controls the ability to send Carbonite and Omniverse logging through the structured log system.

This interface controls the ability to send Carbonite and Omniverse logging through the structured log system.

Structured log settings interface.

Interface for the second version of the IStructuredLogSettings interface.

Interface for the second version of the IStructuredLogSettings interface.

Interface for the third version of the IStructuredLogSettings interface.

Interface for the third version of the IStructuredLogSettings interface.

Structured log settings interface.

Main structured log interface.

A class to build JSON trees using JsonNode structs.

An interface for consuming the output JSON from the JsonSerializer .

An implementation of JsonConsumer that just counts the length of the output string.

An implementation of JsonConsumer that just prints to a fixed string.

A utility that allows you to easily encode JSON data.

Class for determining the allocation size required to build a JSON tree in a single block of memory.

A temporary JsonNode object that will be cleaned up at the end of a scope.

The unexpected value of an expected monad. This is used as a convenient mechanism to report the error case when constructing an expected return.

Implementation of an ABI-safe vector container.

For now, the bool specialization is defined so as to not be used. This way we can decide later if we want to provide an ABI-safe version or not.

A class encapsulating render settings.