RTXSettingsExtension

class omni.rtx.settings.core.RTXSettingsExtension

Bases: IExt

A class for registering and managing RTX setting stacks and renderer configurations.

This class implements functionality to integrate RTX settings within Omni UI. The on_startup method registers various setting stacks, including Common, Ray Tracing, Path Tracing, Real-Time 2.0, and Post Processing. It also registers renderer configurations based on the status of specific settings retrieved via carb.settings. If all renderers are disabled, the configuration falls back to the default enabling of Real-Time and Path Tracing modes to ensure proper functionality. Finally, the user interface is built using RendererSettingsFactory after registration.

The on_shutdown method performs a cleanup by unregistering all previously registered renderer configurations and setting stacks, followed by rebuilding the UI to reflect the changes.

Example: .. code-block:: python

extension = RTXSettingsExtension() extension.on_startup()

Methods

on_shutdown()	Handles shutdown procedure for RTXSettingsExtension.
on_startup()	Handles startup procedure for RTXSettingsExtension.

Attributes

MENU_PATH
rendererNames
stackNames

__init__(self: omni.ext._extensions.IExt) → None

on_shutdown()

Handles shutdown procedure for RTXSettingsExtension. Unregisters all renderers and settings stacks from RendererSettingsFactory.

Builds the UI using RendererSettingsFactory.build_ui after unregistration.

on_startup()

Handles startup procedure for RTXSettingsExtension. Registers renderer settings stacks and renderers with RendererSettingsFactory based on current configuration by retrieving renderer enable states and falling back to defaults if necessary.

Builds the UI using RendererSettingsFactory.build_ui after registration.