Extension: omni.kit.compatibility_mode-1.5.3

Documentation Generated: Oct 09, 2025

Settings#

Settings Provided by the Extension#

persistent.exts.”omni.kit.compatibility_mode”.forceCompatibilityMode#

  • Default Value: false

  • Description: Controls whether compatibility mode is forced to be enabled at startup, persisting this setting across application sessions.

exts.”omni.kit.compatibility_mode”.enableRendererCompatibilityMode#

  • Default Value: true

  • Description: Controls whether to enable the underlying gpu.foundation renderer compatibility mode when compatibility mode is active.

exts.”omni.kit.compatibility_mode”.disableRaytracing#

  • Default Value: false

  • Description: Controls whether to disable raytracing capabilities when compatibility mode is enabled.

exts.”omni.kit.compatibility_mode”.stormOnly#

  • Default Value: true

  • Description: When compatibility mode is active, controls whether to disable all renderers except Storm by setting only the pxr renderer as enabled and active.

persistent.exts.”omni.kit.compatibility_mode”.knownGPUs#

  • Default Value: “”

  • Description: A persistent comma-separated list of known NVIDIA GPUs that is compared with detected GPUs after launch to determine whether to show a dialog asking to disable compatibility mode.

exts.”omni.kit.compatibility_mode”.startupDialogWait#

  • Default Value: 3

  • Description: Controls the number of frames to wait before showing the modal dialog UI asking about compatibility mode changes.

/exts/omni.kit.compatibility_mode/ignoreCompatibilityMode#

  • Description: Setting used to bypass compatibility mode checks, typically set during application relaunch to prevent recursive compatibility mode triggers.

Settings Used by the Extension but Provided by Another Extension#

/renderer/multiGpu/currentGpuCount#

  • Description: Used to check the current number of available GPUs to determine if compatibility mode relaunch is needed.

/exts/omni.kit.renderer.core/compatibilityMode#

  • Description: Used to check if the renderer core is already in compatibility mode before making compatibility decisions.

/app/window/title#

  • Description: Used to get the application window title for displaying in compatibility mode dialog messages.

/app/name#

  • Description: Used as a fallback application name when the window title is not available for dialog messages.

/app/window/width#

  • Description: Used to calculate the horizontal center position for displaying compatibility mode dialogs.

/app/window/height#

  • Description: Used to calculate the vertical center position for displaying compatibility mode dialogs.