FScreenTransform | Unreal Engine 5.0 Documentation

API > API/Runtime > API/Runtime/Renderer

References


Module	Renderer
Header	/Engine/Source/Runtime/Renderer/Public/ScreenPass.h
Include	#include "ScreenPass.h"

Syntax

struct FScreenTransform

Remarks

Generic affine 2D texture coordinate transformation x * S + B.

Construct: FVector2f PointInA = ...; FVector2f PointInB = PointInA * Scale0 + Bias0;

FScreenTransform AToB(Scale0, Bias0); FVector2f PointInB = PointInA * AToB;

Associativity: FVector2f PointInA = ...; FScreenTransform AToB = ...; FScreenTransform BToC = ...; FVector2f PointInC = (PointInA * AToB) * BToC;

FScreenTransform AToC = AToB * BToC; FVector2f PointInC = PointInA * AToC;

Explicit construction by factorization: FVector2f PointInA = ...; FVector2f PointInB = PointInA * Scale0 + Bias0; FVector2f PointInC = PointInB * Scale1 + Bias1;

FScreenTransform AToC = (FScreenTransform::Identity * Scale0 + Bias0) * Scale1 + Bias1; FVector2f PointInC = PointInA * AToC;

Shader code: #include "/Engine/Private/ScreenPass.ush"

FScreenTransform AToC; // shader parameter in global scope

{ float2 PointInA = ...; float2 PointInC = ApplyScreenTransform(PointInA, AToC); }

Variables

	Type	Name	Description
	FVector2f	Bias
	FVector2f	Scale

Constructors

	Type	Name	Description
		FScreenTransform ()
		FScreenTransform ( const FVector2f& InScale, const FVector2f& InBias )

Functions

Type	Name	Description
FScreenTransform	ChangeRectFromTo ( const FIntRect& SrcViewport, const FIntRect& DestViewport )
FScreenTransform	ChangeRectFromTo ( FVector2f SourceOffset, FVector2f SourceExtent, FVector2f DestinationOffset, FVector2f DestinationExtent )	Change of coordinate to map from a rectangle to another.
FScreenTransform	ChangeTextureBasisFromTo ( const FScreenPassTextureViewport& TextureViewport, ETextureBasis SrcBasis, ETextureBasis DestBasis )
FScreenTransform	ChangeTextureBasisFromTo ( const FScreenPassTexture& Texture, ETextureBasis SrcBasis, ETextureBasis DestBasis )
FScreenTransform	ChangeTextureBasisFromTo ( const FIntPoint& TextureExtent, const FIntRect& TextureViewport, ETextureBasis SrcBasis, ETextureBasis DestBasis )	Change of basis for texture coordinate.
FScreenTransform	ChangeTextureUVCoordinateFromTo ( const FScreenPassTextureViewport& SrcViewport, const FScreenPassTextureViewport& DestViewport )	Change TextureUV coordinate from one texture to another, taking into account change in texture extent too.
FScreenTransform	DispatchThreadIdToViewportUV ( const FIntRect& SrcViewport )
FScreenTransform	Invert ( const FScreenTransform& AToB )	Invert a transformation AToB to BToA.
FScreenTransform	SvPositionToViewportUV ( const FIntRect& SrcViewport )