UCompositePassTransform2D

Scales, rotates and translates the layer input in UV space.

API > API/Plugins > API/Plugins/Composite

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

   
Name UCompositePassTransform2D
Type class
Header File /Engine/Plugins/Compositing/Composite/Source/Composite/Public/Passes/CompositePassTransform2D.h
Include Path #include "Passes/CompositePassTransform2D.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, Blueprintable, EditInlineNew, CollapseCategories,  
       Meta=(DisplayName="Transform 2D"))  
class UCompositePassTransform2D : public UCompositePassBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCompositePassTransform2D ( const FObjectInitializer& ObjectInitializer
)

 Constructor Passes/CompositePassTransform2D.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~UCompositePassTransform2D()

 Destructor Passes/CompositePassTransform2D.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bRemoveOverscan bool Automatically remove overscan by reading the camera's overscan value. Passes/CompositePassTransform2D.h
  • BlueprintReadWrite
  • Category="Composite"
bScaleSingleAxis bool How to resolve aspect ratio mismatch. Scales only the mismatched axis, or both axes equally. Passes/CompositePassTransform2D.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • Meta=(EditCondition="ScaleMode == ECompositePassScaleMode::Automatic || ScaleMode == ECompositePassScaleMode::AspectRatio", EditConditionHides)
ContainerAspectRatio FVector2f Container (source) aspect ratio, as width:height (e.g. 16:9). Passes/CompositePassTransform2D.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • Meta=(EditCondition="ScaleMode == ECompositePassScaleMode::AspectRatio", EditConditionHides)
ContentAspectRatio FVector2f Content (target) aspect ratio, typically matching the cine camera, as width:height (e.g. 16:9). Passes/CompositePassTransform2D.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • Meta=(EditCondition="ScaleMode == ECompositePassScaleMode::AspectRatio", EditConditionHides)
ManualScale FVector2f Manual scale factor per axis. Values > 1 zoom in, values < 1 zoom out. Passes/CompositePassTransform2D.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • Meta=(EditCondition="ScaleMode == ECompositePassScaleMode::Manual", EditConditionHides)
Pivot FVector2f Normalized pivot point for rotation and scale. (0.5, 0.5) = viewport center. Passes/CompositePassTransform2D.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
RotationAngle float Counter-clockwise rotation in degrees. Passes/CompositePassTransform2D.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • Meta=(UIMin="-360.0", UIMax="360.0", ClampMin="-360.0", ClampMax="360.0")
ScaleMode ECompositePassScaleMode How to scale-fit the video content into the camera viewport. Passes/CompositePassTransform2D.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
Translation FVector2f 2D translation offset in normalized viewport coordinates. Y > 0 moves the image up. Passes/CompositePassTransform2D.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
UnpadPixels FIntPoint Pixels of black bar padding to crop from each side, per axis. Passes/CompositePassTransform2D.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • Meta=(EditCondition="ScaleMode == ECompositePassScaleMode::Unpad", EditConditionHides, ClampMin="0", UIMax="500")

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedScaleUV TOptional< FVector2f > Cached scale UV computed in GetIsActive() and reused in GetProxy(). Reset after consumption. Passes/CompositePassTransform2D.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FVector2f CalculateScale()

 Calculate the final texture UV scale. Passes/CompositePassTransform2D.h
  • BlueprintCallable
  • Category="Composite"

Public Virtual

Overridden from UCompositePassBase

Name Remarks Include Path Unreal Specifiers

virtual bool GetIsActive ()

 Returns true if the pass should participate in rendering this frame. Passes/CompositePassTransform2D.h  

virtual FCompositeCorePassProxy * GetProxy ( const UE::CompositeCore::FPassInputDecl& InputDecl,
FCompositeTraversalContext& InContext,
FSceneRenderingBulkObjectAllocator& InFrameAllocator
) const

 Override to return a render-thread proxy for this pass. Passes/CompositePassTransform2D.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page