UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FTextSizingParameters Struct Reference

#include <CanvasTypes.h>

Public Member Functions

 FTextSizingParameters ()
 
 FTextSizingParameters (float inDrawX, float inDrawY, float inDrawXL, float inDrawYL, const UFont *inFont=NULL)
 
 FTextSizingParameters (const UFont *inFont, float ScaleX, float ScaleY)
 

Public Attributes

float DrawX
 
float DrawY
 
float DrawXL
 
float DrawYL
 
FVector2D Scaling
 
TObjectPtr< const UFontDrawFont
 
FVector2D SpacingAdjust
 

Detailed Description

General purpose data structure for grouping all parameters needed when sizing or wrapping a string

Constructor & Destructor Documentation

◆ FTextSizingParameters() [1/3]

FTextSizingParameters::FTextSizingParameters ( )
inline

◆ FTextSizingParameters() [2/3]

FTextSizingParameters::FTextSizingParameters ( float  inDrawX,
float  inDrawY,
float  inDrawXL,
float  inDrawYL,
const UFont inFont = NULL 
)
inline

◆ FTextSizingParameters() [3/3]

FTextSizingParameters::FTextSizingParameters ( const UFont inFont,
float  ScaleX,
float  ScaleY 
)
inline

Member Data Documentation

◆ DrawFont

TObjectPtr<const UFont> FTextSizingParameters::DrawFont

the font to use for sizing/wrapping the string

◆ DrawX

float FTextSizingParameters::DrawX

a pixel value representing the horizontal screen location to begin rendering the string

◆ DrawXL

float FTextSizingParameters::DrawXL

a pixel value representing the width of the area available for rendering the string

◆ DrawY

float FTextSizingParameters::DrawY

a pixel value representing the vertical screen location to begin rendering the string

◆ DrawYL

float FTextSizingParameters::DrawYL

a pixel value representing the height of the area available for rendering the string

◆ Scaling

FVector2D FTextSizingParameters::Scaling

A value between 0.0 and 1.0, which represents how much the width/height should be scaled, where 1.0 represents 100% scaling.

◆ SpacingAdjust

FVector2D FTextSizingParameters::SpacingAdjust

Horizontal spacing adjustment between characters and vertical spacing adjustment between wrapped lines


The documentation for this struct was generated from the following file: