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

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