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

# Display

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

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

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

Subclasses: _[DownloadableDisplay](/python-api/docs/downloadabledisplay#downloadabledisplay)_, _[ForwardingDisplay](/python-api/docs/forwardingdisplay#forwardingdisplay)_, _[LocalGuiDisplay](/python-api/docs/localguidisplay#localguidisplay)_, _[PreCompDisplay](/python-api/docs/precompdisplay#precompdisplay)_, _[Screen2](/python-api/docs/screen2#screen2)_, _[SlcAwareDisplay](/python-api/docs/slcawaredisplay#slcawaredisplay)_, _[TwoPoint5DPlate](/python-api/docs/twopoint5dplate#twopoint5dplate)_

## Properties

#### **acesFinalMatrix** : _[Mat](/python-api/docs/mat#mat)_

ACES final matrix

_UserName: Matrix_

#### **acesTransform** : _[AcesOutputTransformParameters](/python-api/docs/acesoutputtransformparameters#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](/python-api/docs/colourprofile#colourprofile)_

Colour/Gamma space of the output display

_Category: Output  
UserName: Colour profile_

#### **colourshift** : _[ColourShift](/python-api/docs/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](/python-api/docs/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](/python-api/docs/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](/python-api/docs/ocioshaderproperties#ocioshaderproperties)_

Available OCIO transform parameters for a given colour space.

_Category: Output  
UserName: OCIO transform properties_

#### **ocioTransform** : _[OcioColourSpace](/python-api/docs/ociocolourspace#ociocolourspace)_

OCIO colour space of the display

_Category: Output  
UserName: Output transform_

#### **pixel\_mask** : _[DxTexture](/python-api/docs/dxtexture#dxtexture)_

Bitmap showing the appearance of each pixel

_Category: Appearance  
UserName: Pixel mask_

#### **pixel\_mask\_size** : _[Vec2](/python-api/docs/vec2#vec2)_

Allows the pixelmask to represent a grid of pixels

#### **population\_mask** : _[DxTexture](/python-api/docs/dxtexture#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](/python-api/docs/product#product)_

Product

_UserName: Product_

#### **resolution** : _[Vec2](/python-api/docs/vec2#vec2)_

The resolution, in pixels

_UserName: Resolution_

#### **scale** : _[Vec](/python-api/docs/vec#vec)_

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

_UserName: Scale_

## Methods

#### **getImageMosaic**(self, iTarget: _int_, etf: _[ExtendedTextureFormat](/python-api/docs/extendedtextureformat#extendedtextureformat)_) -> _[ImageMosaic](/python-api/docs/imagemosaic#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](/python-api/docs/display#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 | int_, 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](/python-api/docs/dxtexture#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.