Files#

Place-holder documentation for core types whose documentation we haven't had a chance to clean-up.

A collection of opaque type definitions needed by multiple Python bindings.

Utilities for script bindings.

Allow access to specific parts of Windows API without including Windows.h.

Utilities for Carbonite clients.

C++20 coroutine helpers.

Carbonite basic defines and helper functions.

Core components for error handling. These functions are the foundation for language-specific bindings and should not be used directly. See omni/Error.h for user-friendly C++ interfaces.

Utilities for finding plugins.

Core header for registering and acquiring interfaces.

Implementation of Carbonite objects.

Macros for defining a Carbonite interface.

Utilities for Carbonite Interface management.

DLL Boundary safe memory management functions.

Helper utilities for Carbonite objects ( carb::IObject ).

Utilities to ease the creation of Carbonite plugins. Most code will include carb/PluginUtils.h instead of this file.

Utilities to ease the creation of Carbonite plugins.

Utilities to ease the creation of Carbonite plugins.

Registered String utility. See carb::RString for more info.

Registered String utility enum values. See carb::RString for more info.

Defines a macro containing the SDK version this header was built with.

Contains carb::startupFramework() and carb::shutdownFramework() . Consider using OMNI_CORE_INIT() , which invokes these methods for you in a safe manner.

Common types used through-out Carbonite.

Utilities for Carbonite version.

Helper utility functions to modify assertion failure behavior.

Provides an interface to allow for more detailed assertion failure dialogues.

Type definitions for carb.assets.plugin

Utilities for carb.assets.plugin

Interface definition for carb.assets.plugin

"Blob" (Binary Large OBject) asset type definition

Implementation of a clock based on the CPU time-stamp counter.

Defines the BufferedObject class.

Carbonite intrusive list container.

Carbonite intrusive unordered multi-map container.

Defines the LocklessQueue class.

Defines the LocklessStack class.

Carbonite Robin-hood Unordered Map container.

Carbonite Robin-hood Unordered Multi-map container.

Carbonite Robin-hood Unordered Multi-set container.

Carbonite Robin-hood Unordered Set container.

Carbonite Robin-hood container generic implementation.

Implementation detail.

Implementation detail.

Implementation detail.

Implementation detail.

C++14-compatible implementation of select functionality from C++ <barrier> library.

C++14-compatible implementation of select functionality from C++ <bit> library.

Carbonite C++14-compatible Chrono library overrides.

C++14-compatible implementation of select functionality from C++ <functional> library.

C++14-compatible implementation of select functionality from C++ <latch> library.

C++14-compatible implementation of select functionality from C++ <memory> library.

C++14-compatible implementation of select functionality from C++ <optional> library.

C++14-compatible implementation of select functionality from C++ <semaphore> library.

C++14-compatible implementation of select functionality from C++ <span> library.

C++14-compatible implementation of select functionality from C++ <cstddef> library.

C++17-compatible implementation of select functionality from C++ <string_view> library.

C++14-compatible implementation of select functionality from C++ <thread> library.

C++14-compatible implementation of select functionality from C++ <type_traits> library.

Implementation detail.

C++14-compatible implementation of the C++ standard library std::data function.

Implementation details.

! !

! !

Carbonite Delegate implementation.

Carbonite Delegate base detail implementation.

Internal utilities for loading Carbonite functions at runtime.

Implementation detail.

Implementation detail.

Implementation detail.

Implementation detail.

Carbonite declarations of functions for TSAN (thread sanitizer) support.

Utility helper functions for common dictionary operations.

carb.dictionary interface definition file.

Interface to handle serializing data from a file format into an carb::dictionary::IDictionary item. This interface is currently implemented in two plugins, each offering a different input/output format - JSON and TOML. The plugins are called carb.dictionary.serializer-json.plugin and carb.dictionary.serializer-toml.plugin . The caller must ensure they are using the appropriate one for their needs when loading, the plugin, acquiring the interface, and performing serialization operations (both to and from strings).

Type definitions for carb.eventdispatcher.plugin

Utilities for carb.eventdispatcher.plugin

Interface definition for IEventDispatcher.

Interface definition for IMessageQueue.

carb.events adapter to carb.eventdispatcher

Helper utilities for carb.events .

carb.events interface definition file.

carb.events adapter to carb.eventdispatcher

Provides a Base64 encoding and decoding helper class.

Utilities for gathering information about the CPU.

Provides some helper functions that check the state of debuggers for the calling process.

Provides a helper class for getting, setting, and restoring environment variables.

Parses environment variables into map of key/value pairs.

Carbonite error handling utilities.

HandleDatabase definition file.

Provides helper functions to handle library loading and management.

Helper to get the memory characteristics of a program.

Provides a set of helper functions to manage the processing of command line arguments.

Path interpretation utilities.

Provides a helper class to manage a block of shared memory.

Wrappers for libc string functions to avoid dangerous edge cases.

Provides helper functions to check the platform a process is running on.

Provides helper functions to manage and evaluate token strings.

Provides helper classes to parse and convert UTF-8 strings to and from Unicode.

UUIDv4 utilities.

Provides helper functions to retrieve setup variable values.

Carbonite Windows path utilities.

Utilities for finding files.

Carbonite FileSystem interface definition file.

Interface definition for carb::input::IInput .

Definitions for the carb::input::InputProvider sub-interface of carb::input::IInput .

Type definitions for carb.input .

Utilities for carb::input::IInput .

The L10n interface.

The L10n interface.

Simple external process launcher helper interface.

Helper classes and functions for the ILauncher interface.

carb.logging interface definition

carb.logging utilities

carb.logging Logger definition

Type definitions for carb.logging .

Utilities for carb.logging .

carb.logging StandardLogger definitions

carb.logging StandardLogger2 definitions

Implementation of int128_t and uint128_t in carb::math namespace.

Math utility for doing a large multiply-divide operation.

Carbonite math utility functions.

Allocator that initially uses a memory arena first (typically on the stack) and then falls back to the heap.

Helper utilities for memory.

Carbonite process types.

Carbonite process utilities.

Monitor interface for carb.profiler .

carb.profiler interface definition file.

carb.profiler macros and helpers

carb.profiler helper utilities.

Interface definition for python threading utilities provided by the Carbonite Framework.

carb.settings interface definition

carb.settings utilities

carb.simplegui interface definition file.

carb.simplegui type definitions.

Carbonite Tasking Delegate implementation.

IFiberEvents definition file.

carb.tasking interface definition file.

IThreadPool definition file.

carb.tasking Parallel Sort algorithm

carb.tasking helper functions

carb.tasking type definitions

carb.tasking utilities.

ThreadPoolWrapper definition file.

carb.tasking parallel algorithm implementation details

Carbonite Futex implementation.

Provides an interface that handles various threading utility operations.

Carbonite mutex and recursive_mutex implementation.

Recursive Shared Mutex implementation.

C++17-compatible Shared Mutex implementation for C++14 or higher.

Carbonite Spinlock implementation.

Carbonite dynamic thread-local storage implementation.

Carbonite thread types.

Carbonite thread utilities.

Futex implementation details.

Implementation detail for LowLevelMutex .

Futex implementation details.

Futex implementation details.

Implementation of a clock based on the CPU time-stamp counter.

Implementation of ITokens interface.

Implementation of utilities for carb::tokens::ITokens .

Interface definition for carb.variant.plugin

Type definitions for carb.variant.plugin

Utilities for carb.variant.plugin

carb.windowing IGLContext interface definition.

carb.windowing interface definitions.

Example app to demonstrate the implementation and use of a simple Carbonite interface. This example app requires the example.carb.stats.plugin plugin.

Example interface that collects arbitrary statistics.

Example. Interface implementation file for the sample Carbonite plugin.

Example. Implementation file for the IStats interface.

Example. Header file for the Stats implementation.

Implementation of omni::expected and related functions and structures.

Implementation of omni::function .

Implementation of omni::span .

ABI safe string implementation.

Implementation of omni::span .

ABI safe std::vector implementation.

Helper macros to provide API calling convention tags.

Helper macros to provide assertion checking macros.

Header file for Omni built-in interfaces.

This file was generated by omni.bind .

Defines the base class for ABI-safe interfaces.

This file was generated by omni.bind .

Provides the ITypeFactory interface declaration.

This file was generated by omni.bind .

Defines omni::core::IWeakObject .

Helper functions for collecting module information.

Helpers for defining a plugin's omni::core::ModuleExports table.

Helper functions for collecting module information.

Main header for the Omniverse core.

Helpers related to define interfaces and interface attributes.

Core header for starting the Omniverse core.

Helper macros to detect the current platform.

This file was generated by omni.bind .

Result codes form the basics of error handling.

Helpers related reporting errors from omni::core::Result .

Helper functions and macros for generating type identifiers.

Common data structs and types.

Provides omni::detail::PointerIterator class for constructing pointer-based iterators.

implementation details for omni::vector

This file was generated by omni.bind .

IJob definition file.

Utilities for omni.ext .

omni.ext interface definition file

This file was generated by omni.bind .

This file was generated by omni.bind .

omni.ext Extension System interfaces

Helper functions for dealing with docker containers.

Helpers for carb::dictionary::Item and carb::dictionary::IDictionary .

Helpers for carb::filesystem::IFileSystem .

Provides functionality to force a symbol to be linked to a module instead of the optimizer potentially removing it out.

Provides templated helper functions to fill an arbitrary array of values.

A set of helper templates to provide platform specific behavior around path handling.

Helper class to retrieve the current privacy settings state.

RTX Settings utilities.

A helper class to provide a resizable scratch buffer.

Helpers for carb.settings .

String manipulation helper utilities.

Helper class to manage a unique process.

Version utilities.

MD5 hash utils.

Utilities for managing EventSubscribers for omni.kit.app.

omni.kit.app interface definition file

Message box interface for omni.kit.app.

Interface definition for IRunLoopRunner for omni.kit.app

Helpers for kit update ordering.

Settings utilities for omni.kit.app.

This file was generated by omni.bind .

Fast, multi-channel logging.

This file was generated by omni.bind .

Provides a base class for a filter for log channel patterns.

This file was generated by omni.bind .

Omni log consumer definitions.

Utilities for handling logging channels.

Provides a helper class to store wildcard patterns for log channels.

This file was generated by omni.bind .

Helper interface to retrieve cgroup CPU info.

This file was generated by omni.bind .

Helper interface to retrieve cgroup memory info.

This file was generated by omni.bind .

Helper interface to retrieve bare metal CPU info.

This file was generated by omni.bind .

Helper interface to retrieve display info.

This file was generated by omni.bind .

Helper interface to retrieve limited CPU info.

This file was generated by omni.bind .

Helper interface to retrieve memory info.

This file was generated by omni.bind .

Helper interface to retrieve memory info.

This file was generated by omni.bind .

Helper interface to retrieve operating system info.

This file was generated by omni.bind .

Helper interface to retrieve operating system info.

Python binding helpers.

This file was generated by omni.bind .

Interface to manage access to a read-only string.

Helper functions to handle matching wildcard patterns.

Module for serializing data into the structured logging queue.

This file was generated by omni.bind .

The core structured logging interface.

This file was generated by omni.bind .

The structured log control interface.

This file was generated by omni.bind .

The structured log control interface.

This file was generated by omni.bind .

Interface to manage extra CloudEvent fields in all structured log messages.

This file was generated by omni.bind .

An interface for redirecting omni::log::ILog messages to structured logging.

This file was generated by omni.bind .

Interface to querying and adjusting structured logging settings.

This file was generated by omni.bind .

Interface to querying and adjusting structured logging settings.

This file was generated by omni.bind .

Interface to querying and adjusting structured logging settings.

Module for manually serializing JSON data with low performance overhead.

ABI safe structure for specifying structured log schemas.

Module for Serializing the omni::structuredlog::JsonNode tree structures.

A string_view wrapper to make telemetry calls easier.

Common types/macros/functions for structured logging.

Utilities for the carb::settings::ISettings settings for structured logging.

Utilities for uploading telemetry events.