omni/core/IObject.h

↰ Parent directory: omni/core/

Defines the base class for ABI-safe interfaces.

Source: omni/core/IObject.h

Included By

• omni/structuredlog/StructuredLogCommon.h: Common types/macros/functions for structured logging.

• omni/structuredlog/IStructuredLog.h: The core structured logging interface.

• omni/structuredlog/IStructuredLogSettings.h: Interface to querying and adjusting structured logging settings.

• omni/structuredlog/IStructuredLogFromILog.h: An interface for redirecting omni::log::ILog messages to structured logging.

• omni/log/ILog.h: Fast, multi-channel logging.

• omni/log/ILogChannelFilter.h: Provides a base class for a filter for log channel patterns.

• omni/core/ModuleExports.h: Helpers for defining a plugin’s omni::core::ModuleExports table.

• omni/core/ModuleInfo.h: Helper functions for collecting module information.

• omni/experimental/job/IJob.h: IJob definition file.

• omni/extras/OutArrayUtils.h: Provides templated helper functions to fill an arbitrary array of values.

• omni/platforminfo/ICpuInfo.h: Helper interface to retrieve CPU info.

• omni/platforminfo/IMemoryInfo.h: Helper interface to retrieve memory info.

• omni/platforminfo/IOsInfo.h: Helper interface to retrieve operating system info.

• omni/str/IReadOnlyCString.h: Interface to manage access to a read-only string.

• omni/structuredlog/IStructuredLogControl.h: The structured log control interface.

Namespaces

• omni: Main namespace for Omniverse.

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

Classes

• omni::core::Implements: Helper template for implementing one or more interfaces.

• omni::core::ImplementsCast: Helper template for implementing the cast function for one or more interfaces.

• omni::core::Inherits: Helper template for interface inheritance.

• omni::core::IObject: Base class for all ABI-safe interfaces. Provides references counting and an ABI-safe dynamic_cast like mechanism.

• omni::core::IObject_abi: Base class for all ABI-safe interfaces. Provides references counting and an ABI-safe dynamic_cast like mechanism.

• omni::core::ObjectPtr: Smart pointer wrapper around interface pointers.

Functions

• omni::core::borrow: Returns an omni::core::ObjectPtr managing the given pointer. omni::core::IObject::acquire() is called on the pointer.

• omni::core::cast: Casts the given pointer to the given interface (e.g. T).

• omni::core::steal: Returns an omni::core::ObjectPtr managing the given pointer. omni::core::IObject::acquire() is not called on the pointer.

Defines

• OMNI_FAILED: Returns true if the given omni::core::Result is a failure code.

• OMNI_RETURN_IF_FAILED: If the given omni::core::Result is a failure code, calls return result to exit the current function.

• OMNI_SUCCEEDED: Returns true if the given omni::core::Result is not a failure code.

Typedefs

• omni::core::Result: Result of an operation.

Variables

• omni::core::kBorrow: Used to create an omni::core::ObjectPtr that increments an objects reference count.

• omni::core::kResultAccessDenied: Access denied.

• omni::core::kResultFail: The operation failed.

• omni::core::kResultInsufficientBuffer: Insufficient buffer.

• omni::core::kResultInvalidArgument: A supplied argument is invalid.

• omni::core::kResultInvalidState: The system is not in a valid state to complete the operation.

• omni::core::kResultNotFound: The item was not found.

• omni::core::kResultNotImplemented: Feature/Method was not implemented.

• omni::core::kResultNotSupported: The operation is not supported.

• omni::core::kResultOperationAborted: The operation was aborted.

• omni::core::kResultOutOfMemory: System is out-of-memory.

• omni::core::kResultSuccess: Success.

• omni::core::kResultTryAgain: Try the operation again.

• omni::core::kResultVersionCheckFailure: Version check failure.

• omni::core::kResultVersionParseError: Failed to parse the version.

• omni::core::kSteal: Used to create an omni::core::ObjectPtr that does not increments an objects reference count. The omni::core::ObjectPtr does decrement the reference count of the raw pointer upon the omni::core::ObjectPtr’s destruction.