FCanvasWordWrapper Class Reference

#include <CanvasTypes.h>

Public Types
typedef TArray< TPair< int32, int32 > >	FWrappedLineData

Public Member Functions
ENGINE_API	FCanvasWordWrapper ()
ENGINE_API void	Execute (FStringView InString, const FTextSizingParameters &InParameters, TArray< FWrappedStringElement > &OutStrings, FWrappedLineData *const OutWrappedLineData)

Member Typedef Documentation

FWrappedLineData

typedef TArray< TPair<int32, int32> > FCanvasWordWrapper::FWrappedLineData

Array of indices where the wrapped lines begin and end in the source string

Constructor & Destructor Documentation

FCanvasWordWrapper()

FCanvasWordWrapper::FCanvasWordWrapper

(

)

Member Function Documentation

Execute()

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

Used to generate multi-line/wrapped text.

Parameters

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

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Public/CanvasTypes.h
• Engine/Source/Runtime/Engine/Private/UserInterface/Canvas.cpp