FTextSizingParameters

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

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/CanvasTypes.h

Include

#include "CanvasTypes.h"

Syntax

struct FTextSizingParameters

Remarks

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

Variables

Name Description

Public variable

const UFont ...

 

DrawFont

The font to use for sizing/wrapping the string

Public variable

float

 

DrawX

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

Public variable

float

 

DrawXL

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

Public variable

float

 

DrawY

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

Public variable

float

 

DrawYL

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

Public variable

FVector2D

 

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.

Public variable

FVector2D

 

SpacingAdjust

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

Constructors

Name Description

Public function

FTextSizingParameters()

Public function

FTextSizingParameters

(
    const UFont* inFont,
    float ScaleX,
    float ScaleY
)

Public function

FTextSizingParameters

(
    float inDrawX,
    float inDrawY,
    float inDrawXL,
    float inDrawYL,
    const UFont* inFont
)

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback