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::ModuleExportEntry: Define an entry in omni::core::ModuleExports.
omni::core::ModuleExportEntryCarbClientName: omni::core::ModuleExports entry to interop wht g_carbClientName.
omni::core::ModuleExportEntryCarbFramework: omni::core::ModuleExports entry to interop with carb::Framework.
omni::core::ModuleExportEntryCarbIAssert: omni::core::ModuleExports entry to interop with carb::assert::IAssert.
omni::core::ModuleExportEntryCarbIL10n: omni::core::ModuleExports entry to interop with carb::l10n::IL10n.
omni::core::ModuleExportEntryCarbILogging: omni::core::ModuleExports entry to interop with carb::logging::ILogging.
omni::core::ModuleExportEntryCarbIProfiler: omni::core::ModuleExports entry to interop with carb::profiler::IProfiler.
omni::core::ModuleExportEntryGetModuleDependencies: omni::core::ModuleExports entry to register a function to advertise the interface implementations available in the plugin.
omni::core::ModuleExportEntryILog: omni::core::ModuleExports entry to access omni::log::ILog.
omni::core::ModuleExportEntryIStructuredLog: omni::core::ModuleExports entry to access omni::structuredlog::IStructuredLog.
omni::core::ModuleExportEntryITypeFactory: Forward declaration for omni::core::ITypeFactory.
omni::core::ModuleExportEntryLogChannel: omni::core::ModuleExports entry to add a logging channel.
omni::core::ModuleExportEntryOnModuleCanUnload: omni::core::ModuleExports entry to register a function to determine if the module can be unloaded.
omni::core::ModuleExportEntryOnModuleLoad: omni::core::ModuleExports entry to register a function to advertise the interface implementations available in the plugin.
omni::core::ModuleExportEntryOnModuleStarted: omni::core::ModuleExports entry to register a function to be called after the plugin has loaded.
omni::core::ModuleExportEntryOnModuleUnload: omni::core::ModuleExports entry to register a function to be called when the plugin is unloaded.
omni::core::ModuleExportEntrySchema: omni::core::ModuleExports entry to add a new structured logging schema to be registered.
omni::core::ModuleExports: Entities exported by a module for both use and population by omni::core::ITypeFactory.
omni::core::ScopedFrameworkStartup: Scoped object which calls carb::startupFramework and carb::shutdownFramework.
omni::core::ScopedOmniCore: Scoped object which calls OMNI_CORE_START and OMNI_CORE_STOP.
omni::core::Api: The API layer of an Omniverse interface.
omni::core::Generated: Templated class to store generated code from the omni.bind code generator.
omni::core::Generated< omni::core::IObject_abi >: Base class for all ABI-safe interfaces. Provides references counting and an ABI-safe
dynamic_cast
like mechanism.omni::core::Generated< omni::experimental::job::IAffinityMask_abi >: Interface for providing a CPU affinity mask to the plugin.
omni::core::Generated< omni::experimental::job::IJob_abi >: Basic interface for launching jobs on a foreign job system.
omni::core::Generated< omni::experimental::job::IJobAffinity_abi >: Interface for setting CPU affinity for the job system.
omni::core::Generated< omni::experimental::job::IJobWorker_abi >: Interface for managing the number of workers in the job system.
omni::core::Generated< omni::log::ILog_abi >: Multi-channel logging interface which can write logs to multiple consumers.
omni::core::Generated< omni::log::ILogChannelFilter_abi >: Read-only object to encapsulate a channel filter’s pattern and effects.
omni::core::Generated< omni::log::ILogChannelFilterList_abi >: A list of channel filters that will be applied as channels are added to the log.
omni::core::Generated< omni::log::ILogChannelFilterListUpdateConsumer_abi >: Consumes (i.e. is notified) when an observed ILogChannelFilterList is updated.
omni::core::Generated< omni::log::ILogChannelUpdateConsumer_abi >: Consumes (listens for) state change to one or more omni::log::ILog objects.
omni::core::Generated< omni::log::ILogMessageConsumer_abi >: Consumes (listens for) log messages.
omni::core::Generated< omni::platforminfo::ICpuInfo_abi >: Interface to collect information about the CPUs installed in the calling system.
omni::core::Generated< omni::platforminfo::IMemoryInfo_abi >: Interface to collect and retrieve information about memory installed in the system.
omni::core::Generated< omni::platforminfo::IOsInfo_abi >: Interface to collect and retrieve information about the operating system.
omni::core::Generated< omni::str::IReadOnlyCString_abi >: Reference counted read-only C-style (i.e. null-terminated) string.
omni::core::Generated< omni::structuredlog::IStructuredLog_abi >: Main structured log interface.
omni::core::Generated< omni::structuredlog::IStructuredLogControl_abi >: Structured log state control interface.
omni::core::Generated< omni::structuredlog::IStructuredLogFromILog_abi >: This interface controls the ability to send Carbonite and Omniverse logging through the structured log system.
omni::core::Generated< omni::structuredlog::IStructuredLogSettings_abi >: Structured log settings interface.
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::ITypeFactory: Undocumented.
omni::core::ObjectParam: 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.
omni::core::ObjectPtr: Smart pointer wrapper around interface pointers.
omni::core::ResultError: Exception object that encapsulates a omni::core::Result along with a customizable message.
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::getModuleFilename: Given an object, returns the name of the module (.dll/.exe) which contains the object’s code.
omni::core::resultToString: Given a omni::core::Result code, returns a human readable interpretation of the code.
omni::core::steal: Returns an omni::core::ObjectPtr managing the given pointer. omni::core::IObject::acquire() is not called on the pointer.
omni::core::typeId: Returns the type id of the given type name at run time.
Typedefs¶
omni::core::GetModuleDependeciesFn: Called to get depencies from the module.
omni::core::ModuleExportEntryFlag: Per omni::core::ModuleExportEntry flags.
omni::core::ModuleGetExportsFn: Type of omni::core::kModuleGetExportsName. See omniModuleGetExports.
omni::core::OnModuleCanUnloadFn: Called to determine if the module can be unloaded.
omni::core::OnModuleLoadFn: Called to load interface implementation registration information.
omni::core::OnModuleStartedFn: This function will be called after the module is fully registered. It is called after omni::core::OnModuleLoadFn successfully returns.
omni::core::OnModuleUnloadFn: Called when the module is about to be unloaded.
omni::core::Result: Result of an operation.
omni::core::TypeId: Base type for an interface type identifier.
Unions¶
omni::core::Float2: Helper struct to represent a single 2-space vector of floating point values.
omni::core::Int2: Helper struct to represent a single 2-space vector of signed integers.
omni::core::UInt2: Helper struct to represent a single 2-space vector of unsigned integers.
Variables¶
omni::core::fModuleExportEntryFlagNone: No flags.
omni::core::fModuleExportEntryFlagRequired: Fail module load if entry could not be populated.
omni::core::kBorrow: Used to create an omni::core::ObjectPtr that increments an objects reference count.
omni::core::kModuleExportEntryTypeCarbClientName: Unique type name for omni::core::ModuleExportEntryCarbClientName.
omni::core::kModuleExportEntryTypeCarbFramework: Unique type name for omni::core::ModuleExportEntryCarbFramework.
omni::core::kModuleExportEntryTypeCarbIAssert: Unique type name for omni::core::ModuleExportEntryCarbIAssert.
omni::core::kModuleExportEntryTypeCarbIL10n: Unique type name for omni::core::ModuleExportEntryCarbIL10n.
omni::core::kModuleExportEntryTypeCarbILogging: Unique type name for omni::core::ModuleExportEntryCarbILogging.
omni::core::kModuleExportEntryTypeCarbIProfiler: Unique type name for omni::core::ModuleExportEntryCarbIProfiler.
omni::core::kModuleExportEntryTypeGetModuleDependencies: Unique type name for omni::core::ModuleExportEntryGetModuleDependencies.
omni::core::kModuleExportEntryTypeILog: Unique type name for omni::core::ModuleExportEntryILog.
omni::core::kModuleExportEntryTypeIStructuredLog: Unique type name for omni::core::ModuleExportEntryIStructuredLog.
omni::core::kModuleExportEntryTypeITypeFactory: Unique type name for omni::core::ModuleExportEntryITypeFactory.
omni::core::kModuleExportEntryTypeLogChannel: Unique type name for omni::core::ModuleExportEntryLogChannel.
omni::core::kModuleExportEntryTypeOnModuleCanUnload: Unique type name for omni::core::ModuleExportEntryOnModuleCanUnload.
omni::core::kModuleExportEntryTypeOnModuleLoad: Unique type name for omni::core::ModuleExportEntryOnModuleLoad.
omni::core::kModuleExportEntryTypeOnModuleStarted: Unique type name for omni::core::ModuleExportEntryOnModuleStarted.
omni::core::kModuleExportEntryTypeOnModuleUnload: Unique type name for omni::core::ModuleExportEntryOnModuleUnload.
omni::core::kModuleExportEntryTypeSchema: Unique type name for omni::core::ModuleExportEntrySchema.
omni::core::kModuleExportsMagic: Magic number for sanity checking of omni::core::ModuleExports.
omni::core::kModuleExportsVersion: Binary layout of omni::core::ModuleExports. This should be incremented if the fields in omni::core::ModuleExports change.
omni::core::kModuleGetExportsName: Name of the module’s exported function that is of type omni::core::ModuleGetExportsFn. See omniModuleGetExports.
omni::core::kResultAccessDenied: Access denied.
omni::core::kResultAlreadyExists: Object already exists.
omni::core::kResultFail: The operation failed.
omni::core::kResultInsufficientBuffer: Insufficient buffer.
omni::core::kResultInvalidArgument: A supplied argument is invalid.
omni::core::kResultInvalidDataSize: Invalid data size.
omni::core::kResultInvalidDataType: Invalid data type.
omni::core::kResultInvalidIndex: Invalid index.
omni::core::kResultInvalidOperation: The operation is invalid.
omni::core::kResultInvalidState: The system is not in a valid state to complete the operation.
omni::core::kResultNoInterface: Interface not implemented.
omni::core::kResultNoMoreItems: No more items to return.
omni::core::kResultNotEnoughData: Not enough data.
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::kResultNullPointer: Pointer is null.
omni::core::kResultOperationAborted: The operation was aborted.
omni::core::kResultOutOfMemory: System is out-of-memory.
omni::core::kResultSuccess: Success.
omni::core::kResultTooMuchData: Too much data.
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.