Display

A base class for Objects which can have content mapped to them, such as screens, projectors and cameras.

Category: Stage

Base class: Object

Subclasses: DownloadableDisplay, ForwardingDisplay, LocalGuiDisplay, PreCompDisplay, Screen2, SlcAwareDisplay, TwoPoint5DPlate

Properties

acesFinalMatrix : Mat

ACES final matrix

UserName: Matrix

acesTransform : AcesOutputTransformParameters

ACES Output Display Transform (ODT)

Category: Output
UserName: Output transform

alpha : float

If the screen is translucent, this controls its opacity

Category: Appearance
UserName: Alpha

blendMode : int

Controls the way the screen is composited with the rest of the stage

Options: {0: ‘Over’, 1: ‘Alpha’, 2: ‘Add’, 3: ‘Multiply’, 7: ‘Premult-Alpha’}
Category: Appearance
UserName: Blend mode

canBeFeedRectSource : bool (Read-Only)

Whether or not this Display can be used as a source for a feed mapping.

colourprofile : ColourProfile

Colour/Gamma space of the output display

Category: Output
UserName: Colour profile

colourshift : ColourShift

Colour Shift applied to correct display device output; does not appear in visualiser

Category: Output
UserName: Colour shift

content : int

Controls which side of the screen shows content

Options: {0: ‘Both Sides’, 1: ‘Front Only’, 2: ‘Back Only’}
Category: Appearance
UserName: Content

holdOutput : bool

If enabled, stop the output of this display from changing

Category: Output
UserName: Hold output

isConnected : bool (Read-Only)

Checks if the display is connected to a parent object.

lutfile : LutFile

Cube LUT applied to correct display device output; does not appear in visualiser

Category: Output
UserName: Colour LUT

master_fade : float

Controls output brightness; is not reflected in the visualiser

Category: Output
UserName: Master fade

mesh : Mesh

The mesh that defines the shape of the object

UserName: Mesh

nTargets : int (Read-Only)

Number of display targets. Default is one, however some displays such as Cameras have multiple display targets.

ocioShaderProperties : OcioShaderProperties

Available OCIO transform parameters for a given colour space.

Category: Output
UserName: OCIO transform properties

ocioTransform : OcioColourSpace

OCIO colour space of the display

Category: Output
UserName: Output transform

pixel_mask : DxTexture

Bitmap showing the appearance of each pixel

Category: Appearance
UserName: Pixel mask

pixel_mask_size : Vec2

Allows the pixelmask to represent a grid of pixels

population_mask : DxTexture

Bitmap that controls whether an output pixel exists or not; should have the same resolution as the screen

Category: Appearance
UserName: Population mask

product : Product

Product

UserName: Product

resolution : Vec2

The resolution, in pixels

UserName: Resolution

scale : Vec

Controls the size; this is a scale factor applied to mesh vertices

UserName: Scale

Methods

getImageMosaic(self, iTarget: int, etf: int) -> ImageMosaic

Get the mosaic of highest quality textures forming the full texture.

This method returns an ImageMosaic, which contains the highest quality versions of the texture fragments for a given display target. These can be recombined to produce the full-resolution target texture.

Parameters:

• iTarget: Index of the display target.
• etf: Requested extended texture format.

Returns An image mosaic containing the highest quality rendered textures for the given display target

needsContent(self, iTarget: int) -> bool

Whether the display needs content rendered to it on this machine.

This method checks whether the current machine is outputting anything which requires content to be rendered to the given display target.

Parameters:

• iTarget: The display target index.

Returns True if the display needs content, false otherwise.

resolveTarget(self, iTarget: int) -> Display

Resolve to the display which should currently be rendered to.

This method is used for displays which forward to other displays, such as MR sets which render to the current active camera. The forwarded display may vary for different display targets (e.g Frontplate, Backplate etc.).

Parameters:

• iTarget: The index of the display target to resolve.

Returns The resolved display.

setContent(self, material: ShaderMaterial, iTarget: int, lodFactor: float)

Apply the content of the display to a specific shader material.

This method is a helper function that sets the display’s compositor targets, containing the rendered content for the given display target, onto an SLC-aware shader material.

Parameters:

• material: The shader material to set the compositor targets on.
• iTarget: The index of the display target to apply to the material
• lodFactor: The LOD factor to use when determining the appropriate compositor targets.

target(self, iTarget: int) -> DxTexture

Get the full raster display target texture for a given index.

This method is a legacy getter for the full raster display target. It throws an exception if SLC is in use on this display.

Parameters:

• iTarget: The index of the display target to retrieve.

Returns The full raster display target texture.

targetName(self, iTarget: int) -> str

Get the name of the display target at the specified index.

Parameters:

• iTarget: Index of the display target.

Returns Name of the display target.