Viewport Settings#

Setting	Description
Navigation	Refer to Navigation Settings for details.
Selection	Refer to Selection Settings for details.
Grid	Refer to Grid Settings for details.
Gizmos	Refer to Gizmos Settings for details.
Viewport	Refer to Viewport Settings for details.
Viewport UI Settings	Refer to Viewport UI Settings for details.
Reset To Defaults	Resets all settings to their default values
Preferences	Opens the Preferences panel

Navigation Settings#

Setting	Description
Navigation Speed	Sets the speed of the camera when navigating in the Viewport
Navigation Speed Scaler	Controls navigation speed
Inertia Mode	Enables inertia on camera movements
Camera Inertia	Controls the inertia of camera movements
Animation Clamp	Sets the maximum animation time limit in seconds

Selection Settings#

Setting	Description
Selection Color	Sets the color for selected entities
Selection Line Width	Sets the size of the selection box
Bounding Box Color	Sets the color of the bounding box

Advanced Selection Outline Settings#

Selection outlines can also be configured through Kit settings. These settings are useful when an extension or script needs to control selection highlighting, such as assigning different outline colors to different selection groups.

Note

These are advanced renderer and viewport settings. They are intended for scripted configuration and extension workflows, not as a replacement for the standard viewport UI.

import carb.settings

settings = carb.settings.get_settings()
# Use each group's outline color for the interior fill.
settings.set("/persistent/app/viewport/outline/mode", 2)

The color settings store one RGBA tuple per selection group in a single float array. Each group uses four values: red, green, blue, and alpha. The first value for group N starts at index N * 4. The default selection group is group 255, so its RGBA tuple starts at index 1020.

import carb.settings

settings = carb.settings.get_settings()

def set_group_rgba(setting_path, group_id, rgba):
    values = list(settings.get(setting_path) or [])
    values.extend([0.0] * (256 * 4 - len(values)))
    start = group_id * 4
    values[start:start + 4] = rgba
    settings.set_float_array(setting_path, values)

default_group = 255

# Use each group's dedicated shade/fill color for the interior fill.
settings.set("/persistent/app/viewport/outline/mode", 3)
set_group_rgba("/persistent/app/viewport/outline/shadeColor", default_group, [0.0, 0.0, 1.0, 0.3])

Setting	Description
`/app/viewport/outline/enabled`	Enables or disables selection outline rendering.
`/persistent/app/viewport/outline/width`	Sets the outline width in pixels. RTX clamps the value to a maximum of `15`.
`/persistent/app/viewport/outline/mode`	Controls how the interior area where outlined objects overlap is filled. `0` disables interior fill, `1` uses the global intersection color, `2` uses the selected group’s outline color, and `3` uses the selected group’s shade/fill color. Use `2` when overlapping selection groups should preserve their group outline colors instead of changing to the global selection color. Use `3` when the interior fill should use a separate color from `/persistent/app/viewport/outline/shadeColor`.
`/persistent/app/viewport/outline/color`	Float array of RGBA outline colors for selection groups. Each group uses four consecutive values: red, green, blue, and alpha.
`/persistent/app/viewport/outline/shadeColor`	Float array of RGBA interior fill colors for selection groups. This setting is used when outline mode is `3`.
`/persistent/app/viewport/outline/intersection/color`	Global RGBA color used for interior fill when outline mode is `1`. In this setting name, “intersection” refers to the interior fill region where selected outlines overlap.
`/persistent/app/viewport/outline/interiorFlags`	Advanced alpha handling for interior fill. `0` uses the alpha from the selected interior color source.

Grid Settings#

Setting	Description
Grid Color	Sets the color of the grid lines
Grid Line Width	Sets the width of the grid lines
Grid Size	Sets the size of the grid cells
Grid Fade	Sets the distance from the camera where the grid lines fade out

Gizmos Settings#

Setting	Description
Gizmo Line Width	Sets the width of the gizmo outline
Gizmo Constant Scale Enabled	Enables constant gizmo scaling
Gizmo Constant Scale	Scales gizmos using this constant value
Gizmo Camera Scale	Scales gizmos based on the camera position
Gizmo Min FadeOut	Sets the distance from the camera where gizmos* appear at full size (Gizmos farther away scale down until the Gizmo Max FadeOut distance where they are no longer visible.)
Gizmo Max FadeOut	Sets the distance from the camera where gizmos* no longer appear

Note

*Only joint gizmos use this feature.

Viewport Settings#

Setting	Description
Render Resolution	Sets the base/custom resolution rendered in the Viewport (With ability to create/save/delete custom resolution)
Render Scale	Upsamples or downsamples your Viewport relative to the specified Render Resolution
Fill Viewport	Fills the viewport with the scene

Viewport UI Settings#

Setting	Description
UI Background Opacity	Sets the background opacity of the Viewport’s control UI
UI Control Brightness	Sets the brightness of the Viewport’s control UI