Enumerations#

OmniBuiltIn

Used by omniGetBuiltInWithoutAcquire() to specify the desired interface.

uint64_t carb::AcquireInterfaceFlags

Flags for use with carb::AcquireInterfaceOptions .

uint32_t carb::BindingType

An enum that describes a binding registration for carb::Framework::registerScriptBinding() .

carb::InitPolicy

Policy directing how the smart pointer is initialized from from raw pointer.

int32_t carb::LoadPluginResult

Result of loading a plugin. Used by carb::Framework::loadPlugin . Non-negative values indicated success.

carb::PluginHotReload

Defines the plugin hot reloading (auto reload) behavior.

carb::PluginReloadState

Lets clients of a plugin know both just before and just after that the plugin is being reloaded.

carb::PrefetchLevel

A prefetch level hint to pass to CARB_PREFETCH()

carb::RStringOp

Operations for RString (and variant classes) constructor.

carb::assets::Reason

The reason a Snapshot was taken or not.

unsigned char carb::cpp::byte

A byte is a distinct type that implements the concept of byte as specified in the C++ language definition. Like char and unsigned char , it can be used to access raw memory occupied by other objects, but unlike those types it is not a character type and is not an arithmetic type. A byte is only a collection of bits, and only bitwise operators are defined for it.

carb::cpp::endian

Indicates the endianness of all scalar types for the current system.

carb::crashreporter::CrashSentResult

Result codes used to notify subscribers of crash dump uploads whether an upload succeed or not.

carb::crashreporter::MetadataValueType

Possible types that a volatile metadata value could be.

carb::dictionary::ChangeEventType

Type of a change passed to a subscription callback.

carb::dictionary::ItemFlag

Item flags that can be specified by the user.

carb::dictionary::ItemType

Supported item types.

carb::dictionary::UpdateAction

Actions that may be returned by carb::dictionary::OnUpdateItemFn .

carb::dictionary::WalkerMode

Mode names for the ways to walk the requested dictionary.

carb::events::AdapterType

Adapter type.

carb::extras::MemoryQueryType

The type of memory to query.

carb::extras::MemoryScaleType

Names for the different types of common memory scales.

carb::extras::SharedState

Bitwise state values returned by carb::extras::HandleDatabase::getSharedState() .

carb::filesystem::ChangeAction

Defines change action that is reported to callback function.

carb::filesystem::DirectoryItemType

Defines the type of directory item.

carb::filesystem::FileStatus

defines the potential states that an open file stream can be in.

carb::filesystem::FileWhence

fixed positions in a file that a file pointer can be moved relative to.

signed char carb::filesystem::WalkAction

Defines the behavior requested by the callback function.

carb::input::CurrentButtonState

Current button state.

carb::input::DeviceType

Defines possible device types.

uint8_t carb::input::FilterResult

The result returned by InputEventFilterFn.

carb::input::GamepadConnectionEventType

Defines the gamepad connection event types.

InputType carb::input::GamepadInput

Defines a gamepad input.

carb::input::KeyboardEventType

Defines keyboard event type.

InputType carb::input::KeyboardInput

Defines keyboard key codes.

carb::input::MouseEventType

Defines the mouse event types.

InputType carb::input::MouseInput

Defines a mouse input.

carb::input::PreviousButtonState

Previous button state.

carb::l10n::LocalizedName

Boolean value tags for the getLanguageName() and getTerritoryName() functions.

carb::launcher::KillStatus

Return statuses for ILauncher::killProcessWithTimeout() .

carb::logging::LogSettingBehavior

Defines a log setting behavior.

carb::logging::OutputStream

Enumerations of output stream types.

carb::logging::OutputType

StandardLogger2 output types.

carb::options::ParseResult

The possible result codes of parsing a single option.

carb::options::ValueType

Type names for values passed to the parser functions.

uint8_t carb::profiler::FlowType

The type of flow event passed to IProfiler::emitFlowStatic() / IProfiler::emitFlowDynamic() . Typically used only by profiler macros.

uint8_t carb::profiler::InstantType

The type of instant event passed to IProfiler::emitInstantStatic() / IProfiler::emitInstantDynamic() .

uint8_t carb::profiler::LockableOperationType

The type of lockable operation event.

carb::scripting::PythonThreadingState

State returned by carb::scripting::IPythonThreading::checkLoaded() .

carb::simplegui::Condition

Condition for simplegui::setWindow***(), setNextWindow***(), setNextTreeNode***() functions.

carb::simplegui::DataType

A primary data type.

carb::simplegui::Direction

A cardinal direction.

carb::simplegui::MouseCursor

Enumeration for GetMouseCursor() User code may request binding to display given cursor by calling SetMouseCursor(), which is why we have some cursors that are marked unused here.

carb::simplegui::StyleColor

Enumeration for pushStyleColor() / popStyleColor()

carb::simplegui::StyleColorsPreset

Predefined Style Colors presets.

carb::simplegui::StyleVar

Defines style variable (properties) that can be used to temporarily modify UI styles.

carb::stats::AggregationType

Names for the different ways a statistic can be aggregated when a new value is added.

carb::stats::StatType

Names for the type of statistic value to be stored or retrieved.

carb::tasking::ObjectType

Object type for Object .

carb::tasking::Priority

Defines a task priority.

carb::tasking::TaskDebugState

Debug state of a task.

carb::thread::RelayResult

Possible result codes for Framework::runRelayTask().

carb::tokens::ResolveResult

Possible result of resolving tokens.

carb::tokens::StringEndingMode

Possible options for ending of the resolved string.

uint32_t carb::windowing::CursorMode

Available cursor modes.

uint32_t carb::windowing::CursorStandardShape

Defines cursor standard shapes.

uint32_t carb::windowing::InputMode

Available input modes.

uint32_t carb::windowing::MonitorChangeEvent

Types of monitor change events.

omni::ext::DownloadState

The download state communicated by registry provider to extension manager.

omni::ext::ExtensionPathType

An enum describing Extensions Path type.

omni::ext::ExtensionStateChangeType

Different moments in extension state lifetime.

omni::extras::ConsentLevel

Consent level names.

omni::kit::MessageBoxButtons

Buttons to place on the message box.

omni::kit::MessageBoxResponse

Message box user response.

omni::kit::MessageBoxType

Message box type.

omni::kit::RestartArgsPolicy

How to handle passed arguments when restarting an app.

uint32_t omni::log::ChannelUpdateReason

Reason for a channel update notification.

int32_t omni::log::Level

Severity of a message.

uint32_t omni::log::SettingBehavior

Defines if a log channel's setting should be respected or if the global logging system's settings should be used.

omni::platforminfo::Architecture

Names for the processor architecture for the system.

omni::platforminfo::CpuFeature

CPU feature names.

omni::platforminfo::Orientation

Possible display orientation names.

omni::platforminfo::Os

Names for the supported operating systems.

omni::structuredlog::IdMode

Names to control how the next event identifier is generated after each event message.

omni::structuredlog::IdType

Names to control what type of event identifiers will be used for each message.

omni::structuredlog::JsonTreeCompareFuzz

Options to do a less of a strict comparison when comparing trees.

uint8_t omni::structuredlog::NodeType

The data type contained within a JsonNode .

omni::structuredlog::SchemaResult

Possible results from registering a new schema.

omni::structuredlog::TelemetryMode

The tag that is applied to structuredlog messages.