unreal.CompositePassCenteredScale

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

Bases: CompositePassBase

Convenience pass to re-scale footage (with black bars) inside its container texture.

C++ Source:

  • Plugin: Composite

  • Module: Composite

  • File: CompositePassCenteredScale.h

Editor Properties: (see get_editor_property/set_editor_property)

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

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

  • overscan (float): [Read-Write] Manual overscan to uncrop, with values from 0.0 to 1.0 matching the source camera overscan.

  • overscan_uncrop_mode (CompositePassOverscanUncropMode): [Read-Write] Uncrop calculation mode used to uncrop a viewport cropped in by overscan.

  • scale_factor (Vector2f): [Read-Write] Manual scale factor.

  • scale_mode (CompositePassScaleMode): [Read-Write] Centered scale calculation mode used to rescale a media texture with black bars into an already constrained aspect ratio viewport.

  • source_aspect_ratio (Vector2f): [Read-Write] Source container aspect ratio (or resolution).

  • target_aspect_ratio (Vector2f): [Read-Write] Embedded target aspect ratio (or resolution), without black bars.

calculate_scale() → Vector2f

Calculate the final texture UV scale.

Return type:

Vector2f

property overscan: float

[Read-Write] Manual overscan to uncrop, with values from 0.0 to 1.0 matching the source camera overscan.

Type:

(float)

property overscan_uncrop_mode: CompositePassOverscanUncropMode

[Read-Write] Uncrop calculation mode used to uncrop a viewport cropped in by overscan.

Type:

(CompositePassOverscanUncropMode)

property scale_factor: Vector2f

[Read-Write] Manual scale factor.

Type:

(Vector2f)

property scale_mode: CompositePassScaleMode

[Read-Write] Centered scale calculation mode used to rescale a media texture with black bars into an already constrained aspect ratio viewport.

Type:

(CompositePassScaleMode)

property source_aspect_ratio: Vector2f

[Read-Write] Source container aspect ratio (or resolution).

Type:

(Vector2f)

property target_aspect_ratio: Vector2f

[Read-Write] Embedded target aspect ratio (or resolution), without black bars.

Type:

(Vector2f)