---
title: "StageRenderSettings"
description: "API documentation for StageRenderSettings"
url: https://developer.disguise.one/python-api/docs/stagerendersettings/
---

# StageRenderSettings

Parameters controlling how cameras render the stage.

Covers rendering aspects shared across cameras, such as object and label  
visibility, the renderer and light models, exposure and anti-aliasing.  
Parameters that affect a camera’s output when using a VideoIn belong on the Camera instead.

See also: [Stage Guide](/plugins/guides/stage)

Base class (inherits properties and methods): _[Resource](/python-api/docs/resource#resource)_

## Properties

#### **backgroundColour** : _[Colour](/python-api/docs/colour#colour)_

Background colour drawn behind the stage

_Category: Renderer  
UserName: Background colour_

#### **drawBeams** : _int_

Selects how projector beams are drawn

_Options: {0: ‘Hidden’, 1: ‘Beam’, 2: ‘Wire’, 3: ‘Beam And Wire’}  
Category: Object Visibility  
UserName: Projectors_

#### **drawCameraLabels** : _bool_

Toggle visibility

_Category: Label Visibility  
UserName: Camera labels_

#### **drawCameras** : _bool_

Toggle display of camera meshes

_Category: Object Visibility  
UserName: Cameras_

#### **drawDMXLightLabels** : _bool_

Toggle visibility

_Category: Label Visibility  
UserName: DMX Light labels_

#### **drawDMXScreenLabels** : _bool_

Toggle visibility

_Category: Label Visibility  
UserName: DMX Screen labels_

#### **drawFixtures** : _bool_

Toggle visibility of fixtures

_Category: Object Visibility  
UserName: Fixtures_

#### **drawFloor** : _bool_

Toggle visibility of floor

_Category: Object Visibility  
UserName: Floor_

#### **drawLEDScreenLabels** : _bool_

Toggle visibility

_Category: Label Visibility  
UserName: LED Screen labels_

#### **drawMeasurements** : _bool_

Toggle display of measured distances. Alt-drag between two points to add a measurement; alt-right-click to remove

_Category: Object Visibility  
UserName: Measurements_

#### **drawMeshNormals** : _bool_

Toggle display of normals for selected meshes

_Category: Object Visibility  
UserName: Mesh normals_

#### **drawMovementSpeed** : _bool_

Toggle display of speeds for moving screens

_Category: Object Visibility  
UserName: Movement speed_

#### **drawProjectionSurfaceLabels** : _bool_

Toggle visibility

_Category: Label Visibility  
UserName: Projection Surface labels_

#### **drawProjectorLabels** : _bool_

Toggle visibility

_Category: Label Visibility  
UserName: Projector labels_

#### **drawPropLabels** : _bool_

Toggle visibility

_Category: Label Visibility  
UserName: Prop labels_

#### **drawPucks** : _bool_

Toggle visibility of people on floor

_Category: Object Visibility  
UserName: People_

#### **drawRangeFinder** : _bool_

Toggle visibility of range finder overlay

_Category: Object Visibility  
UserName: Range finder_

#### **drawReferencePointLabels** : _bool_

Toggle display of labels of reference points

_Category: Label Visibility  
UserName: Reference point labels_

#### **drawReferencePoints** : _bool_

Toggle display of reference points

_Category: Object Visibility  
UserName: Reference points_

#### **drawSkeletonLabels** : _bool_

Toggle visibility

_Category: Label Visibility  
UserName: Skeleton labels_

#### **drawSkeletons** : _bool_

Toggle display of skeletons

_Category: Object Visibility  
UserName: Skeletons_

#### **drawStackedProjectors** : _bool_

Toggle visibility

_UserName: Stacked Projectors_

#### **drawTrackedPointLabels** : _bool_

Toggle display of tracked point labels

_Category: Label Visibility  
UserName: Tracked point labels_

#### **drawTrackedPoints** : _bool_

Toggle display of incoming tracked points (eg: BlackTrax LEDs)

_Category: Object Visibility  
UserName: Tracked points_

#### **drawVenue** : _bool_

Toggle visibility of venue

_Category: Object Visibility  
UserName: Venue_

#### **exposure** : _float_

Camera white point in Lux

_Category: Renderer  
UserName: White Point_

#### **extraTransparencyPasses** : _int_

Number of extra transparency renders to add detail to transparent objects.  
Setting this to 0 handles one layer of transparency.  
Increasing the value will impact performance.

_Category: Renderer  
UserName: Transparency accuracy_

#### **faceCullMode** : _int_

Can optionally skip rendering faces with normals pointing away (back) or toward (front) the camera.

_Options: {0: ‘None’, 1: ‘Front’, 2: ‘Back’}  
Category: Renderer  
UserName: Face Cull Mode_

#### **glowBrightness** : _float_

Impact of glow effect in Lux renderer

_Category: Renderer  
UserName: Glow Brightness_

#### **light** : _int_

How to display the light levels of the scene  
Luminance: as seen by the camera  
Illuminance: as seen by a light meter pointing at the light sources

_Options: {0: ‘Luminance’, 1: ‘Illuminance’}  
Category: Renderer  
UserName: Light_

#### **msaaMode** : _int_

Multisample anti-aliasing level. Only applied in the Schematic renderer

_Options: {0: ‘None’, 1: ‘MSAA 2X’, 2: ‘MSAA 4X’, 3: ‘MSAA 8X’}  
Category: Renderer  
UserName: Anti-aliasing_

#### **renderer** : _int_

Schematic shows content; Lux shows what the content would actually look like in the real world; Heatmap shows lux-levels

_Options: {0: ‘Schematic’, 1: ‘Lux’, 2: ‘Heatmap’, 3: ‘Depth’}  
Category: Renderer  
UserName: Renderer_

#### **ssaoDownsample** : _int_

Downsampling factor applied when computing screen-space ambient occlusion

_UserName: Down Sample_

#### **ssaoKernelSize** : _int_

Number of samples taken by the screen-space ambient occlusion effect

_UserName: Kernel Size_

#### **ssaoNoiseSize** : _int_

Size of the noise texture used to randomise ambient occlusion sampling

_UserName: Noise Size_

#### **ssaoPower** : _float_

Power of the ambient occlusion effect in Lux renderer. 0 disables it

_Category: Renderer  
UserName: Ambient Occlusion Power_

#### **ssaoRadius** : _float_

Sampling radius of the screen-space ambient occlusion effect

_UserName: Radius_

#### **virtualObjectAlpha** : _float_

Opacity of virtual objects (in render layers other than On-Stage or Off-Stage)

_Category: Object Visibility  
UserName: Virtual object alpha_

## Variables

#### **Heatmap** : _Final\[int\]_ = 2

Index of the Heatmap renderer option

#### **Lux** : _Final\[int\]_ = 1

Index of the Lux renderer option

#### **Schematic** : _Final\[int\]_ = 0

Index of the Schematic renderer option

## Methods

#### **appliesToOmnicalCamera**(self) -> _bool_

Whether these settings are currently applied to any Omnical camera.

**Returns** True if at least one Omnical camera uses these render settings.

#### **appliesToSphericalCamera**(self) -> _bool_

Whether these settings are currently applied to any spherical camera.

**Returns** True if at least one spherical camera uses these render settings.

#### **appliesToVisualiserCamera**(self) -> _bool_

Whether these settings are currently applied to the local visualiser camera.

**Returns** True if the local visualiser camera uses these render settings.

#### **setAllLabelVisibility**(self, visible: _bool_)

Show or hide all stage labels at once.

**Parameters**:

-   visible: Whether all labels should be visible.