FCanvasWordWrapper::Execute

Used to generate multi-line/wrapped text.

Windows
MacOS
Linux

References

Module

Engine

Header

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

Include

#include "CanvasTypes.h"

Source

/Engine/Source/Runtime/Engine/Private/UserInterface/Canvas.cpp

Syntax

void Execute
(
    const TCHAR *const InString,
    const FTextSizingParameters & InParameters,
    TArray< FWrappedStringElement > & OutStrings,
    FWrappedLineData *const OutWrappedLineData
)

Remarks

Used to generate multi-line/wrapped text.

Parameters

Parameter

Description

InString

The unwrapped text.

InFontInfo

The font used to render the text.

InWrapWidth

The width available.

OutWrappedLineData

An optional array to fill with the indices from the source string marking the begin and end points of the wrapped lines
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss