Variables#

Flag to indicate that the assertion should not produce any console output.

Flag to indicate that the software breakpoint that is triggered on a failing assertion is to be ignored.

Flag to indicate that the assertion confirmation dialog should always be skipped for this process.

Used to identify an invalid asset id.

Used to identify an invalid pool.

Used to identify an invalid snapshot.

A constant of type size_t that is used to differentiate carb::cpp::span of static and dynamic extent.

Alias for the value member of the is_bounded_array template.

Alias for the value member of the is_unbounded_array template.

Constant that identifies an empty optional object. This can be used to initialize or reinitialize an empty optional object as needed.

An instance of unsafe_length_t for convenience.

Base magic signature value used to verify crash reporter resources.

Signal number to use to handle external termination requests.

Special metadata identifier to indicate an invalid metadata value or general failure in registering the value with addVolatileMetadata*().

Current magic signature used to verify crash reporter resources.

Special metadata identifier to indicate that a bad parameter was passed into one of the ICrashReporter::addVolatileMetadata *() functions.

Special metadata identifier to indicate that the key being registered is either a known reserved key or has already been registered as a volatile metadata key.

Flag that indicates that the const char* string value can actually be considered as char* and treated destructively (allow in-situ modification by the deserializer).

Flag to indicate that if an empty dictionary item is found while walking the dictionary that is being serialized, it should be represented by an empty array.

Deprecated flag name for fSerializerOptionIncludeDictionaryName .

Flags to affect the behavior of the ISerializer::createStringBufferFromDictionary() function.

Flag to indicate that the generated string should be formatted to be human readable and look 'pretty'.

Flag to indicate that the JSON serializer should write out infinity and NaN floating point values as a null object.

Default value for DeserializerOptions that specifies no options.

Deprecated flag.

Deprecated flag.

Deprecated serializer option flag names.

Deprecated flag.

Deprecated flag.

Alias for keepOriginal() .

Alias for overwriteOriginal() .

The default Order value.

Special value indicating an invalid observer.

Default order value.

Default sender id to use if you don't want it to be unique.

Flag to indicate that the symbols in the library being loaded should be linked to first and take precedence over global scope symbols of the same name from other libraries.

Flag to indicate that a valid library handle should only be returned if the requested library was already loaded into the process.

Flag to indicate that only the module's base name was given and that the full name should be constructed using createLibraryNameForModule() before attempting to load the library.

Flag to indicate that the library should be fully loaded and linked immediately.

Flag to indicate that the library should be "pinned"; that is, it should stay loaded until the process is terminated.

A value representing an invalid library handle.

Flag to indicate that the file must also exist in order for the function to succeed.

When matching wildcards, only match the "stem".

Default empty flag.

Flag to recursively search directories.

Before walking the filesystem, a text replace is performed on each given search path. The token ${MY_ENV_VAR} would be replaced with the environment variable MY_ENV_VAR .

Indicates an invalid subscription.

A value that means any available device.

UTF-8 RFC3629 - max 4 bytes per character.

The separator used for device name components.

Represents all event types.

An invalid SubscriptionId with value 0.

The separator used for modifiers.

The 'default' subscription ordering, same as kSubscriptionOrderLast .

Represents the 'first' subscription.

Represents the 'last' subscription.

Four character code used to identify a PluginRegistrationDesc object that is likely to have further data provided in it.

FNV-1a 64-bit hash basis.

FNV-1a 64-bit hash prime.

Defines the current version of the Carbonite framework.

A value indicating an invalid load hook handle.

A value indicating an invalid register hook handle.

Timeout constant.

The currently set language will be used when this is passed.

The default language will be used when this is passed.

Use the main language table for the process if this is passed.

This is returned from some interface functions when an unknown language is requested.

Flag to indicate that ILauncher::killProcess() or ILauncher::killProcessWithTimeout() calls should simply fail if a debugger is currently attached to the child process being terminated.

Flag to indicate that a child process should be force killed.

Flag to indicate that any direct child processes of the process being terminated should also be terminated.

Flag to indicate that the ILauncher::killProcess() or ILauncher::killProcessWithTimeout() calls should not wait for the child process to fully exit before returning.

Flag to indicate that the child process should still continue to be launched even if the environment block for it could not be created for any reason.

Flag to indicate that launching the child process should not fail if either of the log files fails to open for write.

Flag to indicate that reading from the stdout or stderr streams of the child process should be handled as a byte stream.

When the fLaunchFlagKillOnParentExit flag is also used, this indicates that the child process should be forcibly terminated instead of just being asked to exit when the parent process dies.

Flag to indicate that the new child process should be killed when the calling parent process exits.

Flag to indicate that the child process should be launched fully detached from the launching (ie: parent) process.

Flag to indicate that reading from the stdout or stderr streams of the child process should be handled as a message stream.

Flag to indicate that the calling process's environment should not be inherited by the child process in addition to the new environment variables specified in the launch descriptor.

Flags to indicate that the child process' standard output streams should be closed upon launch.

Flags to indicate that the child process' standard output streams should be closed upon launch.

Flags to indicate that the child process' standard output streams should be closed upon launch.

Flag to indicate that the stdin stream for the child process should be opened and accessible on the side of the parent process.

Flag to indicate that the requested command should be launched as a script.

Flag to indicate that the settings in the requested tree should be added recursively to the argument collector.

Flag to indicate that the wait should succeed when any of the flagged streams have been successfully waited on.

Flag to indicate that the stderr stream for a child should be closed before waiting on it.

Flag to indicate that the stdout stream for a child should be closed before waiting on it.

Flag to indicate that the stderr stream should be waited on.

Flag to indicate that the stdout stream should be waited on.

Special value to indicate a bad process identifier.

A default buffer size to use for reading from a child process's stdout or stderr streams.

Indicates an infinite timeout for use in the ILauncher::waitProcessExit() function in its timeout parameter.

Interpreter names for python scripts.

Interpreter names for python scripts.

Standard command interpreters for Windows and Linux.

Standard command interpreters for Windows and Linux.

Special value that can be passed to ILauncher::writeProcessStdin() for the bytes parameter to indicate that the input is a null terminated UTF-8 string.

Special exit code to indicate that the process is still running and has not exited yet.

The new extra field value will be treated as global on all threads for this process.

No special behavior will be used when only this flag is specified.

The new extra field value will only be added for or modified in the calling thread.

Flag to indicate that logging to the system specific debug console is enabled.

Flag to indicate that logging to a file is currently enabled.

Special value to indicate that no log destinations are currently enabled.

Flag to indicate that logging to the standard streams (ie: stdout and stderr) is enabled.

Can be used by setFileConfiguration.

A mapping of log level names to integer value.

The number of items in kStringToLevelMappings .

An instantiation of the round_away_from_zero_t policy type that can be passed to mulDiv() .

An alias of round_away_from_zero .

An alias of round_toward_zero .

An instantiation of the round_nearest_neighbor_t policy type that can be passed to mulDiv() .

An instantiation of the round_toward_zero_t policy type that can be passed to mulDiv() .

Captures all events.

If zero is provided to an event function, it becomes this.

Captures no events, effectively disabling the profiler.

The mask used by the profiler for profiling itself.

Special value to indicate that a GPU context ID is invalid.

Special value to indicate that a LockableId is invalid.

Returned as an error by IProfiler::registerStaticString() if the string could not be registered.

A marker returned by IProfiler::beginStatic() / IProfiler::beginDynamic() to indicate that the zone should be discarded, typically because it doesn't match the current capture mask.

A marker that is returned IProfiler::beginStatic() / IProfiler::beginDynamic() on error and can be passed to IProfiler::endEx() to prevent zone validation checking.

ColorEdit, ColorPicker: show vertical alpha bar/gradient in picker.

ColorEdit, ColorPicker, ColorButton: display preview as a transparent color over a checkerboard, instead of opaque.

ColorEdit, ColorPicker, ColorButton: display half opaque / half checkerboard, instead of opaque.

[DataType] ColorEdit, ColorPicker, ColorButton: display values formatted as 0.0f..1.0f floats instead of 0..255 integers. No round-trip of value via integers.

(WIP) ColorEdit: Currently only disable 0.0f..1.0f limits in RGBA edition (note: you probably want to use ImGuiColorEditFlags_Float flag as well).

[Inputs]

[Inputs]

ColorEdit, ColorPicker, ColorButton: ignore Alpha component (read 3 components from the input pointer).

ColorEdit, ColorPicker: disable inputs sliders/text widgets (e.g. to show only the small preview colored square).

ColorEdit, ColorPicker: disable display of inline text label (the label is still forwarded to the tooltip and picker).

ColorEdit: disable toggling options menu when right-clicking on inputs/small preview.

ColorEdit: disable picker when clicking on colored square.

ColorPicker: disable bigger color preview on right side of the picker, use small colored square preview instead.

ColorEdit, ColorPicker: disable colored square preview next to the inputs. (e.g. to show only the inputs)

ColorEdit, ColorPicker, ColorButton: disable tooltip when hovering the preview.

Absence of other color edit flags.

[PickerMode] // ColorPicker: bar for Hue, rectangle for Sat/Value.

[PickerMode] // ColorPicker: wheel for Hue, triangle for Sat/Value.

[Inputs] ColorEdit: choose one among RGB/HSV/HEX. ColorPicker: choose any combination using RGB/HSV/HEX.

[DataType] ColorEdit, ColorPicker, ColorButton: display values formatted as 0..255.

Max ~20 items visible.

As many fitting items as possible.

Composed flag.

Max ~8 items visible (default)

Max ~4 items visible. Tip: If you want your combo popup to be a specific size you can use SetNextWindowSizeConstraints() prior to calling BeginCombo()

Display on the preview box without the square arrow button.

Display only a square arrow button.

Absence of other combo flags.

Align the popup toward the left by default.

Tab bar will automatically hide when there is a single window in the dock node.

Don't display the dockspace node but keep it alive. Windows docked into this dockspace node won't be undocked.

Disable docking inside the Central Node, which will be always kept empty.

Disable resizing child nodes using the splitter/separators. Useful with programmatically setup dockspaces.

Disable splitting the node into smaller nodes. Useful e.g. when embedding dockspaces into a main root one (the root one may have splitting disabled to reduce confusion)

Absence of other dock node flags.

Enable passthru dockspace: 1) DockSpace() will render a ImGuiCol_WindowBg background covering everything excepted the Central Node when empty. Meaning the host window should probably use SetNextWindowBgAlpha(0.0f) prior to Begin() when using this. 2) When Central Node is empty: let inputs pass-through + won't display a DockingEmptyBg background. See demo for details.

AcceptDragDropPayload() will returns true even before the mouse button is released. You can then call IsDelivery() to test if the payload needs to be delivered.

Do not draw the default highlight rectangle when hovering over target.

Request hiding the BeginDragDropSource tooltip from the BeginDragDropTarget site.

For peeking ahead and inspecting the payload before delivery.

Absence of other drag/drop flags.

Allow items such as Text(), Image() that have no unique identifier to be used as drag source, by manufacturing a temporary identifier based on their window-relative position. This is extremely unusual within the simplegui ecosystem and so we made it explicit.

Automatically expire the payload if the source cease to be submitted (otherwise payloads are persisting while being dragged)

External source (from outside of simplegui), won't attempt to read current item/window info. Will always return true. Only one Extern source can be active simultaneously.

By default, when dragging we clear data so that IsItemHovered() will return true, to avoid subsequent user code submitting tooltips. This flag disable this behavior so you can still call IsItemHovered() on the source item.

Disable the behavior that allows to open tree nodes and collapsing header by holding over them while dragging a source item.

By default, a successful call to BeginDragDropSource opens a tooltip so you can display a preview or description of the source contents. This flag disable this behavior.

All corners.

Bottom.

Bottom left.

Bottom right.

Left.

Right.

Top.

Top left.

Top right.

IsWindowFocused(): Return true if any window is focused.

IsWindowFocused(): Return true if any children of the window is focused.

Absence of other focused flags.

Composed flag.

IsWindowFocused(): Test from root window (top most parent of the current hierarchy)

Return true even if an active item is blocking access to this item/window. Useful for Drag and Drop patterns.

Return true even if a popup window is normally blocking access to this item/window.

Return true even if the item is disabled.

Return true even if the position is overlapped by another window.

IsWindowHovered() only: Return true if any window is hovered.

IsWindowHovered() only: Return true if any children of the window is hovered.

Return true if directly over the item/window, not obstructed by another window, not obstructed by an active popup or modal blocking inputs under them.

Composed flag.

Composed flag.

IsWindowHovered() only: Test from root window (top most parent of the current hierarchy)

Pressing TAB input a \t character into the text field.

Insert mode.

Select entire text when first taking mouse focus.

Call user function every time. User code may query cursor position, modify text buffer.

Call user function to filter character. Modify data->EventChar to replace/filter input, or return 1 to discard character.

Call user function on pressing TAB (for completion handling)

Call user function on pressing Up/Down arrows (for history handling)

Callback on buffer capacity changes request (beyond buf_size parameter value)

Allow 0123456789.+-*‍/

Allow 0123456789ABCDEFabcdef

Filter out spaces, tabs.

Allow 0123456789.+-*‍/eE (Scientific notation input)

Turn a..z into A..Z

In multi-line mode, unfocus with Enter, add new line with Ctrl+Enter (default is opposite: unfocus with Ctrl+Enter, add line with Enter).

Return 'true' when Enter is pressed (as opposed to when the value was modified)

Disable following the cursor horizontally.

Disable undo/redo. Note that input text owns the text data while active, if you want to provide your own undo/redo stack you need e.g. to call ClearActiveID().

Absence of other input text flags.

Password mode, display all characters as '*'.

Read-only mode.

Button repeat.

Absence of other item flags.

Disable interactions.

No Navigation.

No Navigation Default Focus.

MenuItem/Selectable() automatically closes current Popup window.

No tab stop.

Indicates ALT is held.

Indicates CTRL is held.

Indicates no key modifiers.

Indicates SHIFT is held.

Indicates a "super key" is held (Cmd/Windows/etc.).

Generate press events on double clicks too.

Cannot be selected, display grayed out text.

Clicking this don't close parent popup window.

Absence of other selectable flags.

Selectable frame can span all columns (text will still fit in current column)

Automatically select new tabs when they appear.

Composed flag.

Composed flag.

Resize tabs when they don't fit.

Add scroll buttons when tabs don't fit.

Disable behavior of closing tabs (that are submitted with p_open != NULL ) with middle mouse button. You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false .

No scrolling buttons.

Disable tooltips when hovering a tab.

Absence of other tab bar flags.

Allow manually dragging tabs to re-order them + New tabs are appended at the end of list.

Tab list popup button.

Disable behavior of closing tabs (that are submitted with p_open != NULL ) with middle mouse button. You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false .

Don't call PushID(tab->ID)/PopID() on BeginTabItem()/EndTabItem()

Absence of other tab item flags.

Trigger flag to programmatically make the tab selected when calling BeginTabItem()

Append '*' to title without affecting the ID; as a convenience to avoid using the ### operator. Also: tab is selected on closure and closure is deferred by one frame to allow code to undo it without flicker.

Hit testing to allow subsequent widgets to overlap this one.

Display a bullet instead of arrow.

Composed flag indicating collapsing header.

Default node to be open.

Use FramePadding (even for an unframed text node) to vertically align text baseline to regular widget.

Full colored frame (e.g. for CollapsingHeader)

No collapsing, no arrow (use as a convenience for leaf nodes).

(WIP) Nav: left direction may move to this TreeNode() from any of its child (items submitted between TreeNode and TreePop)

Don't automatically and temporarily open node when Logging is active (by default logging will automatically open tree nodes)

Don't do a TreePush() when open (e.g. for CollapsingHeader) = no extra indent nor pushing on ID stack.

Absence of other tree node flags.

Only open when clicking on the arrow part. If kTreeNodeFlagOpenOnDoubleClick is also set, single-click arrow or double-click all box to open.

Need double-click to open node.

Draw as selected.

Platform Window: Disable platform decorations: title bar; borders; etc.

Platform Window: Don't take focus when created.

Platform Window: Don't take focus when clicked on.

Platform Window: Make mouse pass through so we can drag this window while peaking behind it.

Platform Window: Renderer doesn't need to clear the framebuffer ahead.

Platform Window: Disable platform task bar icon (for popups; menus; or all windows if ImGuiConfigFlags_ViewportsNoTaskBarIcons if set)

Absence of other viewport flags.

Platform Window: Display on top (for tooltips only)

Window Flag to resize every window to its content every frame.

Window Flag to always show horizontal scrollbar (even if content Size.x < Size.x).

Window Flag to ensure child windows without border uses style.WindowPadding. Ignored by default for non-bordered child windows, because more convenient.

Window Flag to always show vertical scrollbar (even if content Size.y < Size.y).

Window Flag to allow horizontal scrollbar to appear (off by default). You may use SetNextWindowContentSize(Float2(width,0.0f)) , prior to calling Begin() to specify width.

Window Flag to state that this has a menu-bar.

Window Flag to disable drawing background color (WindowBg, etc.) and outside border. Similar as using SetNextWindowBgAlpha(0.0f).

Window Flag to disable bringing window to front when taking focus. (Ex. clicking on it or programmatically giving it focus).

Window Flag to disable user collapsing window by double-clicking on it.

Special composed Window Flag to disable all decorative elements.

Disable docking of this window.

Window Flag to disable taking focus when transitioning from hidden to visible state.

Special composed Window Flag to disable input.

Window Flag to disable catching mouse, hovering test with pass through.

Window Flag to disable user moving the window.

Special composed Window Flag to disable navigation.

No focusing toward this window with gamepad/keyboard navigation (e.g. skipped by CTRL+TAB)

No gamepad/keyboard navigation within the window.

Window Flag to disable user resizing with the lower-right grip.

Window Flag to never load/save settings in .ini file.

Window Flag to disable user vertically scrolling with mouse wheel. On child window, mouse wheel will be forwarded to the parent unless NoScrollbar is also set..

Window Flag to disable user moving the window.

Window Flag to disable the title bar.

Indicates the absence of all other window flags.

Append '*' to title without affecting the ID, as a convenience to avoid using the ### operator. When used in a tab/docking context, tab is selected on closure and closure is deferred by one frame to allow code to cancel the closure (with a confirmation popup, etc.) without flicker.

A special statistic identifier value to indicate that the given statistic is invalid or that an error occurred.

An instantiation of Split_t .

A constant for ITasking wait functions indicating "infinite" timeout.

A specific value for TaskContext that indicates a non-valid TaskContext.

Represents an invalid TaskStorageKey.

Historically, the absolute maximum number of fibers that ITasking will create.

Flags available for use in the relay task itself.

Flag to indicate that a relay task should block until the task completes.

Force the execution of the task even if a failure related to relaying the task occurs.

The number of CPUs represented by an individual cpu mask.

If cannot resolve token in a string then leave it as is.

Default token resolution process.

Flag to indicate that ILog usage should be disabled on startup instead of creating the internal version or expecting that the caller to provide an implementation of the ILog interface that has already been instantiated.

Flag to indicate that IStructuredLog usage should be disabled on startup instead of creating the internal version or expecting that the caller to provide an implementation of the IStructuredLog interface that has already been instantiated.

Defines the global variable that holds the pointer to the IAssert implementation.

The client's name.

Global accessor object for the loaded ICrashReporter object.

Defines the client's global carb::Framework pointer.

Pointer to the interface for use from CARB_LOCALIZE() .

A global weak variable cache of the logging function.

A global weak variable representing the current log level.

A global weak variable cache of the logging interface.

Global pointer used to store the carb::profiler::IProfiler interface.

A global variable used as a cache for the result of carb::profiler::IProfiler::getCaptureMask() .

Pointer to the function called by CARB_LOCALIZE() .

Global symbol to enforce the use of CARB_GLOBALS() in Carbonite modules. Do not modify or use this value.

See carb::GetFrameworkVersionFn . Required by plugins.

See carb::GetPluginDepsFn . Optional for plugins.

See carb::OnPluginPostShutdownFn . Optional for plugins.

See carb::OnPluginPreStartupFn . Optional for plugins.

See carb::OnPluginQuickShutdownFn . Optional for plugins.

See carb::OnPluginRegisterEx2Fn . Required by plugins.

See carb::OnPluginRegisterExFn . Required by plugins.

See carb::OnPluginRegisterFn . Required by plugins.

See carb::OnPluginShutdownFn . Optional for plugins.

See carb::OnPluginStartupExFn . Optional for plugins.

See carb::OnPluginStartupFn . Optional for plugins.

See carb::OnReloadDependencyFn . Optional for plugins.

Version of OmniCoreStartArgs struct passed to omniCoreStart .

No flags.

Fail module load if entry could not be populated.

Flag to indicate that no special change in behavior should be used when registering a plugin or implementation.

Used to create an ObjectPtr that increments an objects reference count.

Unique type name for omni::core::ModuleExportEntryCarbClientName .

Unique type name for omni::core::ModuleExportEntryCarbFramework .

Unique type name for omni::core::ModuleExportEntryCarbIAssert .

Unique type name for omni::core::ModuleExportEntryCarbIL10n .

Unique type name for omni::core::ModuleExportEntryCarbILogging .

Unique type name for omni::core::ModuleExportEntryCarbIProfiler .

Unique type name for omni::core::ModuleExportEntryGetModuleDependencies .

Unique type name for omni::core::ModuleExportEntryILog .

Unique type name for omni::core::ModuleExportEntryIStructuredLog .

Unique type name for omni::core::ModuleExportEntryITypeFactory .

Unique type name for omni::core::ModuleExportEntryLogChannel .

Unique type name for omni::core::ModuleExportEntryOnModuleCanUnload .

Unique type name for omni::core::ModuleExportEntryOnModuleLastChanceShutdown .

Unique type name for omni::core::ModuleExportEntryOnModuleLoad .

Unique type name for omni::core::ModuleExportEntryOnModuleStarted .

Unique type name for omni::core::ModuleExportEntryOnModuleUnload .

Unique type name for omni::core::ModuleExportEntrySchema .

Magic number for sanity checking of omni::core::ModuleExports .

Binary layout of omni::core::ModuleExports . This should be incremented if the fields in omni::core::ModuleExports change.

Name of the module's exported function that is of type omni::core::ModuleGetExportsFn . See omniModuleGetExports .

Access has been denied for this operation.

Object already exists.

The operation failed.

Insufficient buffer.

An operation was interrupted. An "interruption" happens in cases where the operation did not complete successfully due to an outside system (such as a timer) interrupting it. For example, a function Result wait_for(duration d) might give kResultSuccess when function returns because the duration expired and kResultInterrupted if the system is shutting down.

One or more of the arguments passed to a given function was invalid.

Invalid data size. This arises when the correct type of data is requested, but the requester believes the data size is different from the receiver. The cause of this is typically a version mismatch.

Invalid data type. This is used in cases where a specific type of data is requested, but that is not the data which the receiver has.

Invalid index.

The operation was not valid for the target. For example, attempting to perform a write operation on a read-only file would result in this error.

The system is in an invalid state to perform the operation. This is distinct from kResultInvalidOperation in that it covers situations like "system is not yet started" or "file is closed.".

Interface not implemented.

No more items to return. This is meant for things like reader queues when they have run out of data and will never have more data. For cases where something like an async queue being temporarily empty, use kResultTryAgain .

Not enough data.

The item was not found.

The feature or method was not implemented. It might be at some point in the future.

The operation is not supported.

Pointer is null.

The operation was aborted.

A system is out of memory. This does not necessarily mean resident memory has been exhausted (although it can), as this code can be used to special conditions such as exhausting graphics memory or running out of a specific memory pool. It can also indicate that an allocation would have been too big and failed ahead of time.

Operation successful. No error occurred.

Timed out.

Too much data.

Try the operation again. This is typically emitted in situations where an operation would require blocking, but the system is configured to be non-blocking. For example, attempting to read from a TCP socket when no data has been received would return kResultTryAgain .

Version check failure.

Failed to parse the version.

Would block.

Used to create an ObjectPtr that does not increments an objects reference count. The ObjectPtr does decrement the reference count of the raw pointer upon the ObjectPtr 's destruction.

The version number of a TypeFactoryArgs object being passed around. This is used to manage backward and forward compatibility checks when an implementation receives the object. Newer versions of a type factory implementation are expected to be able to handle the layout and content of any older version of this object.

A constant of type size_t that is used to differentiate carb::cpp::span of static and dynamic extent.

Default order.

An event type denoting the beginning of pulling an extension.

An event type denoting the end of pulling an extension with failure.

An event type denoting the successful end of pulling an extension.

An event type denoting a changed folder (legacy version).

Legacy events sent to IApp::getMessageBusEventStream() by extension manager.

An event type denoting end of registry refresh with failure.

An event type denoting the successful end of registry refresh.

The event name denoting that a script changed (legacy version).

Extension Summary flag meaning that extensions are enabled.

Extension Summary flag meaning that an extension is built-in.

Extension Summary flag meaning that an extension is installed.

Empty flag.

An event dispatched at the beginning of an extension pull.

An event dispatched at the end of extension pull.

The event name denoting that a folder changed.

The event name denoting that a folder changed (immediate).

Other global updates issued by the extension manager.

An event dispatched at the end of registry refresh.

The event name denoting that a script changed.

Extension manager change events.

Default delimiters for stringToInt2 .

Default whitespace characters for string trimming functions.

A flag value to select the omni::string constructor that allows printf style formatting.

Flag that indicates that the display is the primary one in the system.

Flag to indicate that the default functionality should be used when generating the machine ID value.

Flag to indicate that the generated machine ID should be created with the addition of extra information that changes frequently.

Flag to indicate that the generated machine ID should be created with the addition of extra information that stays the same for the duration of the calling process.

Flag to indicate that this mode will be centered on the display.

Flag to indicate that the screen mode is interlaced.

Flag to indicate that this mode will be stretched.

Name for the first version of the machine ID generation algorithm.

Placeholder name for the current version of the machine ID generation algorithm supported by this implementation of this plugin.

Special mode index value to get the information for a display's current mode.

Special value indicating that no CPU scheduling quota has been set.

Flag to indicate that the event should only be added to the queue on commit but that the consumer thread should not be started yet if it is not already running.

Flag to indicate that an enable state change should affect the entire system, not just one schema or event.

Flag to indicate that the enable state of each event in a schema should be overridden when the fEnableFlagWholeSchema flag is also used.

Flag to indicate that a call to IStructuredLog::setEnabled() should affect the entire schema that the named event ID belongs to instead of just the event.

Flag to indicate that this event is critical to succeed and should potentially block the calling thread on IStructuredLog::allocEvent() calls if the event queue is full.

Flag to indicate that this event should be output to the stderr file.

Flag to indicate that this event should be output to the stdout file.

Flag to indicate that this event should not be output to the schema's specified log file.

Use the log file specified by the owning event's schema instead of the default log for the process.

Value to indicate that no special flags are being specified.

Flag to indicate that the cloud heartbeat events should be emitted as well as the normal heartbeat events.

Special flag value to indicate that no output flags are being specified.

Flag to indicate that only emit the payload portion of each message as the full output instead of including the CloudEvents wrapper as well.

Flag to indicate that no header should be written out to log files created by the structured logging system.

Flag to indicate that the privacy settings keys that the privacy settings that could affect user privacy functionality should be explicitly reset to their default values before loading the new privacy file.

Flag to indicate that the log file should remain open between messages.

Flag to indicate that the log file for this schema should include the process ID in the filename.

A special value to indicate that an operation should affect all registered schemas.

The setting path that will indicate which type of anonymous user ID will be used in cases where no user ID is provided in the privacy.toml file or the privacy.toml file is missing.

A special value to indicate a bad event identifier.

The default mode for how a random user ID is chosen.

The default state for whether the cloud heartbeat events will be emitted.

The default state for whether the CloudEvents wrapper will be output with each message.

The default enable mode for the 'JSON on stdout' feature.

The default value for the event queue size in bytes.

The default minimum time between heartbeat events in seconds.

The default mode for generating event IDs.

The default type of event ID to generate.

The default log name to use.

A special name to request the log file path for the default log (if set).

A special name for the default log output path.

The default log retention setting.

Constants for default and minimum values for various settings.

The default state for whether headers will be added to each written log file.

The default high water mark for the queue.

The setting path that will indicate whether the cloud heartbeat events will be enabled.

The setting path that will indicate whether the CloudEvents wrapper should be added to the payload of each emitted event.

The setting path that indicates whether the 'JSON on stdout' functionality is enabled or not.

The setting path for the log consumer toggle.

The setting path for the event identifier mode.

The setting path for the event identifier data type.

The setting path for the size of the event queue buffer in kilobytes.

The setting path to an array that will contain zero or more values that will be used to disable or enable events when they are first registered.

The setting path that will contain zero or more keys that will be used to disable events when they are first registered.

The settings branch that will be expected to contain zero or more key/value pairs for extra fields to be added to each output message.

Names for various settings that can be used to override some of the default settings.

Special value to indicate that the heartbeat event should be disabled.

The setting path that will contain the minimum number of seconds between heartbeat events A heartbeat event is one that is sent periodically to help calculate session lengths even if the expected 'exit' or 'crash' process lifetime events are missing.

Specifies the directory that log files should be written to.

The setting path for the log retention count.

The setting path for the log size limit in megabytes.

The maximum allowed event queue size in bytes.

Approximate size of the maximum data payload in bytes that a message can contain that can be transmitted in a single message.

Approximate size of the maximum data payload in bytes that a message can contain that can be transmitted in a single message when the payload is encoded in Base64.

The minimum allowed event queue size in bytes.

The minimum allowed log retention setting.

The minimum value that can be set for the log size limit in bytes.

The setting path that will indicate whether headers will be added to each log file that is written to disk.

A special string length value to indicate that a string parameter to a generated event sending function is null terminated and should have its length calculated instead of passing in an explicit length.

The current event payload parser version that will be used in the IStructuredLog interface.

The setting path for the privacy settings file to load.

This sets the point where omni.structuredlog will decide that the queue is overfilled and will automatically increase the queue size.

The recommended size for the event queue when log redirection is enabled.

The setting path to an array that will contain zero or more values that will be used to disable or enable schemas when they are first registered.

The setting path that will contain zero or more keys that will be used to disable schemas when they are first registered.

This is the path for settings tree that contains the set of schemas or wildcards to set the maximum allowable throughput measured in bytes per second.

This is the path for settings tree that contains the set of schemas or wildcards to set the time period (in milliseconds) for the throughput limits defined by kSchemasThroughputLimitsSetting .

The expected base name for the structured log plugin.

This allows the transmitter to run as the root user on Linux.

This setting is an optional member of the kTransmitterSetting object.

This allows only a subset of the extra fields specified under /structuredLog/extraFields/ to be passed on to the transmitter when it is launched.

This setting is an optional member of the kTransmitterSetting object.

This allows the name of the transmitter launch guard to be changed from its default.

The log file path that will be used for any transmitter processes launched.

The log level that will be used for any transmitter process launched.

This setting is an optional member of the kTransmitterSetting object.

This setting is an optional member of the kTransmitterSetting object.

The time, in seconds, that the transmitter will wait between polling the log files.

This setting is an optional member of the kTransmitterSetting object.

This setting is an optional member of the kTransmitterSetting object.

This controls whether the extra fields specified in kExtraFieldsToAddSetting will be replaced in each message if one or more of them already exists or if any fields that already exist in the event will just be ignored.

This setting is an optional member of the kTransmitterSetting object.

The assumption of success or failure that should be assumed if the country name and code could not be retrieved.

The list of restricted regions for the transmitter.

This setting is an optional member of the kTransmitterSetting object.

This setting is an optional member of the kTransmitterSetting object.

Telemetry transmitter app settings.

This setting is an optional member of the kTransmitterSetting object.

This setting is an optional member of the kTransmitterSetting object.

This setting is an optional member of the kTransmitterSetting object.

This setting is an optional member of the kTransmitterSetting object.

This setting is an optional member of the kTransmitterSetting object.

Environment variable name that allows the kTelemetryEnableAnonymousDataSetting setting to be overridden externally.

Setting to enable an anonymous data telemetry mode.

This setting is an optional member of the kTransmitterSetting object.

The mode to run the transmitter in.

Sets the run environment that determines which flavor of Kit is currently being run.

This setting is an optional member of the kTransmitterSetting object.

This can be used to apply the "(dev)" and "(test)" source tags onto structured log messages without applying the other behavior of kTelemetryModeSetting .

This setting is an optional member of the kTransmitterSetting object.

This settings key holds an object or an array of objects.

When this setting is set to true, it will cause the transmitter to try to upload all the events that are currently stored and exit once there are no remaining events.

This allows the telemetry transmitter to be launched in an 'open endpoint' mode.

A flag value to select the omni::string constructor that allows vprintf style formatting.

Settings path for persistent default settings.

Settings path for RTX default settings.

Settings path for RTX flag settings.

Worst case hashed setting string length.

Hashed setting key.

Worst case hashed setting root path length.

Internal setting key.

Settings root keys.

Settings path for persistent settings.

Default Setting Flag.

Value indicating no settings flags.

Flag to indicate that resetting of the setting under /rtx-defaults is not allowed.

Indicates that a setting flag is transient.

Settings path for RTX settings.

Settings path for transient RTX settings.