unreal.CompositePassTransform2D

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

Bases: CompositePassBase

Scales, rotates and translates the layer input in UV space. Supports aspect-ratio fit, padding removal and manual scale modes.

C++ Source:

  • Plugin: Composite

  • Module: Composite

  • File: CompositePassTransform2D.h

Editor Properties: (see get_editor_property/set_editor_property)

  • container_aspect_ratio (Vector2f): [Read-Write] Container (source) aspect ratio, as width:height (e.g. 16:9). Automatic derives this from the plate texture.

  • content_aspect_ratio (Vector2f): [Read-Write] Content (target) aspect ratio, typically matching the cine camera, as width:height (e.g. 16:9). Automatic derives this from the camera component.

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

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

  • manual_scale (Vector2f): [Read-Write] Manual scale factor per axis. Values > 1 zoom in, values < 1 zoom out.

  • pivot (Vector2f): [Read-Write] Normalized pivot point for rotation and scale. (0.5, 0.5) = viewport center.

  • remove_overscan (bool): [Read-Write] Automatically remove overscan by reading the camera’s overscan value.

  • rotation_angle (float): [Read-Write] Counter-clockwise rotation in degrees.

  • scale_mode (CompositePassScaleMode): [Read-Write] How to scale-fit the video content into the camera viewport.

  • scale_single_axis (bool): [Read-Write] How to resolve aspect ratio mismatch. Scales only the mismatched axis, or both axes equally.

  • translation (Vector2f): [Read-Write] 2D translation offset in normalized viewport coordinates. Y > 0 moves the image up.

  • unpad_pixels (IntPoint): [Read-Write] Pixels of black bar padding to crop from each side, per axis. For example, (656, 0) removes 656px of pillarbox from left and right.

calculate_scale() → Vector2f

Calculate the final texture UV scale.

Return type:

Vector2f

property container_aspect_ratio: Vector2f

height (e.g. 16:9). Automatic derives this from the plate texture.

Type:

(Vector2f)

Type:

[Read-Write] Container (source) aspect ratio, as width

property content_aspect_ratio: Vector2f

height (e.g. 16:9). Automatic derives this from the camera component.

Type:

(Vector2f)

Type:

[Read-Write] Content (target) aspect ratio, typically matching the cine camera, as width

property manual_scale: Vector2f

[Read-Write] Manual scale factor per axis. Values > 1 zoom in, values < 1 zoom out.

Type:

(Vector2f)

property pivot: Vector2f

[Read-Write] Normalized pivot point for rotation and scale. (0.5, 0.5) = viewport center.

Type:

(Vector2f)

property remove_overscan: bool

[Read-Write] Automatically remove overscan by reading the camera’s overscan value.

Type:

(bool)

property rotation_angle: float

[Read-Write] Counter-clockwise rotation in degrees.

Type:

(float)

property scale_mode: CompositePassScaleMode

[Read-Write] How to scale-fit the video content into the camera viewport.

Type:

(CompositePassScaleMode)

property scale_single_axis: bool

[Read-Write] How to resolve aspect ratio mismatch. Scales only the mismatched axis, or both axes equally.

Type:

(bool)

property translation: Vector2f

[Read-Write] 2D translation offset in normalized viewport coordinates. Y > 0 moves the image up.

Type:

(Vector2f)

property unpad_pixels: IntPoint

[Read-Write] Pixels of black bar padding to crop from each side, per axis. For example, (656, 0) removes 656px of pillarbox from left and right.

Type:

(IntPoint)