unreal.CompositeLayerSceneCapture

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

Bases: CompositeLayerBase

Layer that renders selected primitives through a scene capture (or inlined custom render pass) and merges the result. By default, registered primitives are hidden from the main render so they are rendered exclusively into this capture.

C++ Source:

  • Plugin: Composite

  • Module: Composite

  • File: CompositeLayerSceneCapture.h

Editor Properties: (see get_editor_property/set_editor_property)

  • actors (Array[Actor]): [Read-Write] List of actors to be rendered from the scene capture.

    Automatically sets the scene capture’s ShowOnlyComponents when updated.

  • cached_visibility_in_scene_capture (Map[PrimitiveComponent, bool]): [Read-Write] deprecated: CachedVisibilityInSceneCapture is now deprecated.

  • custom_render_pass (bool): [Read-Write] Convenience toggle to render the scene capture as a fast/minimal Custom Render Pass, inlined in the main render & without support for lighting.

    Automatically sets the scene capture’s CaptureSource, bRenderInMainRenderer & bIgnoreScreenPercentage when updated.

  • display_name (str): [Read-Write] The display name of the pass

  • is_enabled (bool): [Read-Write] Whether or not the pass is active.

  • layer_passes (Array[CompositePassBase]): [Read-Write] Sub-passes applied to this layer’s input before it is merged into the composite stack.

  • name (str): [Read-Write] Deprecated layer display name, use UCompositePassBase::DisplayName. deprecated: Use DisplayName instead.

  • operation (CompositeCoreMergeOp): [Read-Write] Merge operation applied on Input0 with Input1.

  • render_target_resolution (IntPoint): [Read-Write] Render target resolution for the scene capture.

  • visible_in_scene_capture_only (bool): [Read-Write] Visibility setting applied to registered actors. By default, registered meshes will only be visible in scene captures and no longer in the main render.

property actors: None

[Read-Write] List of actors to be rendered from the scene capture.

Automatically sets the scene capture’s ShowOnlyComponents when updated.

Type:

(Array[Actor])

property cached_visibility_in_scene_capture: None

[Read-Write] deprecated: CachedVisibilityInSceneCapture is now deprecated.

Type:

(Map[PrimitiveComponent, bool])

property custom_render_pass: bool

[Read-Write] Convenience toggle to render the scene capture as a fast/minimal Custom Render Pass, inlined in the main render & without support for lighting.

Automatically sets the scene capture’s CaptureSource, bRenderInMainRenderer & bIgnoreScreenPercentage when updated.

Type:

(bool)

property render_target_resolution: IntPoint

[Read-Write] Render target resolution for the scene capture.

Type:

(IntPoint)

property visible_in_scene_capture_only: bool

[Read-Write] Visibility setting applied to registered actors. By default, registered meshes will only be visible in scene captures and no longer in the main render.

Type:

(bool)