Commands#
Public command API for module omni.rtx.window.settings:
RestoreDefaultRenderSettingCommand#
Restore default setting for Renderer Command.
Arguments#
path: Path to the setting to be reset.
Usage#
import omni.kit.commands
# Define the render setting path to restore to its default value
render_setting_path = "/rtx/renderSettings/Exposure"
# Execute the command to restore the default render setting at the specified path
omni.kit.commands.execute("RestoreDefaultRenderSettingCommand", path=render_setting_path)
RestoreDefaultRenderSettingSectionCommand#
Restore default settings for the whole section Command.
Arguments#
path: Path to the settings section to be reset.
Usage#
import omni.kit.commands
# Specify the settings section path that you want to restore to its default values.
section_path = "/rtx/renderSettings"
# Execute the command to restore default render settings for the specified section.
omni.kit.commands.execute("RestoreDefaultRenderSettingSectionCommand", path=section_path)
SetCurrentRenderer#
Sets the current renderer
Arguments#
renderer_name: name of the renderer
Usage#
import omni.kit.commands
# Set the current renderer to "RTX_Renderer"
omni.kit.commands.execute("SetCurrentRenderer", renderer_name="RTX_Renderer")
SetCurrentStack#
Sets the current stack (needs to be one which is valid for the current renderer)
Arguments#
stack_name: name of the stack
Usage#
import omni.kit.commands
# Set the current stack (must be valid for the current renderer)
# For example, setting the stack to "MyCustomStack"
omni.kit.commands.execute("SetCurrentStack", stack_name="MyCustomStack")