unreal.DisplayClusterConfigurationClusterNode

class unreal.DisplayClusterConfigurationClusterNode(outer: Object | None = None, name: Name | str = 'None')

Bases: DisplayClusterConfigurationData_Base

Display Cluster Configuration Cluster Node

C++ Source:

  • Plugin: nDisplay

  • Module: DisplayClusterConfiguration

  • File: DisplayClusterConfigurationTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • enable_texture_share (bool): [Read-Write] Enables texture sharing for this cluster node

  • fixed_aspect_ratio (bool): [Read-Write] Locks the application window aspect ratio for easier resizing

  • graphics_adapter (int32): [Read-Write] Hint for setting the r.GraphicsAdapter CVar when launching this cluster node. Note that this is distinct from the GPU Node Indices assigned to viewports.

  • host (str): [Read-Write] IP address of this specific cluster Node

  • is_fullscreen (bool): [Read-Write] Enables application window native fullscreen support

  • is_sound_enabled (bool): [Read-Write] Enables or disables sound on nDisplay primary Node

  • is_unlocked (bool): [Read-Write]

  • is_visible (bool): [Read-Write]

  • media (DisplayClusterConfigurationMediaViewport): [Read-Write] deprecated: This property has been deprecated. Please use ‘MediaSettings’.

  • media_settings (DisplayClusterConfigurationMediaNodeBackbuffer): [Read-Write] Media settings

  • output_remap (DisplayClusterConfigurationFramePostProcess_OutputRemap): [Read-Write] Output remapping settings for the selected cluster node

  • postprocess (Map[str, DisplayClusterConfigurationPostprocess]): [Read-Write]

  • preview_image (DisplayClusterConfigurationExternalImage): [Read-Write] Binds a background preview image for easier output mapping

  • render_headless (bool): [Read-Write] Activates headless rendering for this cluster node

  • viewports (Map[str, DisplayClusterConfigurationViewport]): [Read-Only]

  • window_rect (DisplayClusterConfigurationRectangle): [Read-Write] Defines the application window size in pixels

property enable_texture_share: bool

[Read-Only] Enables texture sharing for this cluster node

Type:

(bool)

get_referenced_mesh_names() Array[str]

Return all references to meshes from policy, and other

Returns:

out_mesh_names (Array[str]):

Return type:

Array[str]

get_viewport(viewport_id) DisplayClusterConfigurationViewport

Get Viewport

Parameters:

viewport_id (str) –

Return type:

DisplayClusterConfigurationViewport

get_viewport_ids() Array[str]

Get Viewport Ids

Returns:

out_viewport_ids (Array[str]):

Return type:

Array[str]

property graphics_adapter: int

[Read-Only] Hint for setting the r.GraphicsAdapter CVar when launching this cluster node. Note that this is distinct from the GPU Node Indices assigned to viewports.

Type:

(int32)

property host: str

[Read-Only] IP address of this specific cluster Node

Type:

(str)

property is_fullscreen: bool

[Read-Only] Enables application window native fullscreen support

Type:

(bool)

property is_sound_enabled: bool

[Read-Write] Enables or disables sound on nDisplay primary Node

Type:

(bool)

property media: DisplayClusterConfigurationMediaViewport

[Read-Write] deprecated: This property has been deprecated. Please use ‘MediaSettings’.

Type:

(DisplayClusterConfigurationMediaViewport)

property media_settings: DisplayClusterConfigurationMediaNodeBackbuffer

[Read-Write] Media settings

Type:

(DisplayClusterConfigurationMediaNodeBackbuffer)

property output_remap: DisplayClusterConfigurationFramePostProcess_OutputRemap

[Read-Write] Output remapping settings for the selected cluster node

Type:

(DisplayClusterConfigurationFramePostProcess_OutputRemap)

property postprocess: None

[Read-Only]

Type:

(Map[str, DisplayClusterConfigurationPostprocess])

property render_headless: bool

[Read-Only] Activates headless rendering for this cluster node

Type:

(bool)

property viewports: None

[Read-Only]

Type:

(Map[str, DisplayClusterConfigurationViewport])

property window_rect: DisplayClusterConfigurationRectangle

[Read-Write] Defines the application window size in pixels

Type:

(DisplayClusterConfigurationRectangle)