Navigation
API > API/Runtime > API/Runtime/Engine
General purpose data structure for grouping all parameters needed when sizing or wrapping a string
| Name | FTextSizingParameters |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Public/CanvasTypes.h |
| Include Path | #include "CanvasTypes.h" |
Syntax
USTRUCT ()
struct FTextSizingParameters
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| CanvasTypes.h | |||
FTextSizingParameters
(
const UFont* inFont, |
CanvasTypes.h | ||
FTextSizingParameters
(
float inDrawX, |
CanvasTypes.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DrawFont | TObjectPtr< const UFont > | The font to use for sizing/wrapping the string | CanvasTypes.h | |
| DrawX | float | A pixel value representing the horizontal screen location to begin rendering the string | CanvasTypes.h | |
| DrawXL | float | A pixel value representing the width of the area available for rendering the string | CanvasTypes.h | |
| DrawY | float | A pixel value representing the vertical screen location to begin rendering the string | CanvasTypes.h | |
| DrawYL | float | A pixel value representing the height of the area available for rendering the string | CanvasTypes.h | |
| Scaling | FVector2D | A value between 0.0 and 1.0, which represents how much the width/height should be scaled, where 1.0 represents 100% scaling. | CanvasTypes.h | |
| SpacingAdjust | FVector2D | Horizontal spacing adjustment between characters and vertical spacing adjustment between wrapped lines | CanvasTypes.h |