Navigation
API > API/Plugins > API/Plugins/Composite
Convenience pass to re-scale footage (with black bars) inside its container texture.
| Name | UCompositePassCenteredScale |
| Type | class |
| Header File | /Engine/Plugins/Compositing/Composite/Source/Composite/Public/Passes/CompositePassCenteredScale.h |
| Include Path | #include "Passes/CompositePassCenteredScale.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, Blueprintable, EditInlineNew, CollapseCategories,
Meta=(DisplayName="Centered Scale Pass"))
class UCompositePassCenteredScale : public UCompositePassBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCompositePassBase → UCompositePassCenteredScale
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCompositePassCenteredScale
(
const FObjectInitializer& ObjectInitializer |
Constructor | Passes/CompositePassCenteredScale.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~UCompositePassCenteredScale() |
Destructor | Passes/CompositePassCenteredScale.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Overscan | float | Manual overscan to uncrop, with values from 0.0 to 1.0 matching the source camera overscan. | Passes/CompositePassCenteredScale.h |
|
| OverscanUncropMode | ECompositePassOverscanUncropMode | Uncrop calculation mode used to uncrop a viewport cropped in by overscan. | Passes/CompositePassCenteredScale.h |
|
| ScaleFactor | FVector2f | Manual scale factor. | Passes/CompositePassCenteredScale.h |
|
| ScaleMode | ECompositePassScaleMode | Centered scale calculation mode used to rescale a media texture with black bars into an already constrained aspect ratio viewport. | Passes/CompositePassCenteredScale.h |
|
| SourceAspectRatio | FVector2f | Source container aspect ratio (or resolution). | Passes/CompositePassCenteredScale.h |
|
| TargetAspectRatio | FVector2f | Embedded target aspect ratio (or resolution), without black bars. | Passes/CompositePassCenteredScale.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FVector2f CalculateScale() |
Calculate the final texture UV scale. | Passes/CompositePassCenteredScale.h |
|
Overridden from UCompositePassBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool GetProxy
(
const UE::CompositeCore::FPassInputDecl& InputDecl, |
Getter function to override, returning pass proxies to be passed to the render thread. | Passes/CompositePassCenteredScale.h | |
virtual bool IsActive() |
Returns true if the pass is returns a valid proxy. | Passes/CompositePassCenteredScale.h |