RTXSettingsWindow#

class omni.rtx.window.settings.RTXSettingsWindow(usd_context_name='')#

Bases: object

A class for managing the Render Settings window for RTX settings in an Omni UI application.

This class handles the initialization and configuration of a Render Settings window based on carb settings and USD stage rendering events. When auto window creation is enabled, it creates a dedicated window with a settings widget. In cases where auto creation is disabled, it initializes a placeholder widget so that deferred UI and stack updates do not take effect until triggered by external events.

Parameters:: usd_context_name (str) – The name of the USD context used to retrieve stage rendering events and configure deferred UI initialization.

Methods

`__init__`([usd_context_name])	Initializes the RTXSettingsWindow instance.
`destroy`()	Destroys and cleans up the settings widget and window resources.
`get_current_renderer`()	Retrieves the currently active renderer from the settings widget.
`get_current_stack`()	Returns the currently active configuration stack.
`get_registered_renderers`()	Returns the set of registered renderers from the settings widget.
`get_renderer_stacks`(renderer_name)	Retrieves the list of stacks available for a specific renderer.
`register_renderer`(name, stacks_list)	Registers a new renderer with the provided stacks list.
`register_stack`(name, stack_class)	Registers a new configuration stack for render settings.
`set_current_renderer`(renderer_name)	Sets the current renderer by its name.
`set_render_settings_to_viewport_renderer`(...)	Applies render settings to the viewport renderer by forwarding parameters.
`set_visibility_changed_listener`(listener)	Sets a callback function that listens to visibility changes of the window.
`set_visible`(value)	Sets the visibility state of the window.
`show_stack_from_name`(name)	Displays the configuration stack corresponding to the provided name.
`unregister_renderer`(name)	Unregisters the specified renderer from the settings widget.
`unregister_stack`(name)	Unregisters the specified configuration stack from the settings widget.

__init__(usd_context_name='')#: Initializes the RTXSettingsWindow instance.

destroy() → None#: Destroys and cleans up the settings widget and window resources.

get_current_renderer()#: Retrieves the currently active renderer from the settings widget.

get_current_stack() → str#: Returns the currently active configuration stack.

get_registered_renderers()#: Returns the set of registered renderers from the settings widget.

get_renderer_stacks(renderer_name)#

Retrieves the list of stacks available for a specific renderer.

Parameters:: renderer_name (str) – Name of the renderer that provides the stacks.

register_renderer( name: str, stacks_list: List[str], ) → None#

Registers a new renderer with the provided stacks list.

Parameters:

name (str) – Renderer name.
stacks_list (List[str]) – List of stacks associated with the renderer.

register_stack( name: str, stack_class: Callable, ) → None#

Registers a new configuration stack for render settings.

Parameters:

name (str) – Name of the stack.
stack_class (Callable) – Callable that defines the stack.

set_current_renderer(renderer_name: str) → None#

Sets the current renderer by its name.

Parameters:: renderer_name (str) – Name of the renderer to set as current.

set_render_settings_to_viewport_renderer(

*args,

**kwargs,

)#

Applies render settings to the viewport renderer by forwarding parameters.

Parameters:: args (tuple) – Additional positional arguments.

set_visibility_changed_listener(listener)#

Sets a callback function that listens to visibility changes of the window.

Parameters:: listener (Callable) – Listener function triggered on visibility changes.

set_visible(value: bool) → None#

Sets the visibility state of the window.

Parameters:: value (bool) – Visibility flag to show or hide the window.

show_stack_from_name(name: str) → None#

Displays the configuration stack corresponding to the provided name.

Parameters:: name (str) – Name of the stack to be displayed.

unregister_renderer(name)#

Unregisters the specified renderer from the settings widget.

Parameters:: name (str) – Name of the renderer to unregister.

unregister_stack(name)#

Unregisters the specified configuration stack from the settings widget.

Parameters:: name (str) – Name of the stack to unregister.