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.
Properties
backgroundColour : 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.