Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FCanvasTextItem

Text item with misc optional items such as shadow, centering etc.

Windows

MacOS

Linux

Inheritance Hierarchy

FCanvasItem

FCanvasTextItemBase

FCanvasTextItem

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/CanvasItem.h
Include	#include "CanvasItem.h"

Syntax

class FCanvasTextItem : public FCanvasTextItemBase

Remarks

Text item with misc optional items such as shadow, centering etc.

Variables

	Name	Description
const UFont ...	Font	Font to draw text with.
TOptional< FSla...	SlateFontInfo	Font info to draw the text with.
FText	Text	The text to draw.

Constructors

	Name	Description
	FCanvasTextItem ( const FVector2D& InPosition, const FText& InText, const UFont* InFont, const FLinearColor& InColor )	Text item
	FCanvasTextItem ( const FVector2D& InPosition, const FText& InText, const FSlateFontInfo& InFontInfo, const FLinearColor& InColor )	Text item

Functions

	Name	Description
void	DrawStringInternal_OfflineCache ( FCanvas* InCanvas, const FVector2D& DrawPos, const FLinearColor& DrawColor )	Internal string draw In a method to make it simpler to do effects like shadow, outline
void	DrawStringInternal_RuntimeCache ( FCanvas* InCanvas, const FVector2D& DrawPos, const FLinearColor& DrawColor )
EFontCacheTy...	GetFontCacheType()	Get the type of font cache the UFont is using

Name

Description

DrawStringInternal_OfflineCache

(
    FCanvas* InCanvas,
    const FVector2D& DrawPos,
    const FLinearColor& DrawColor
)

Internal string draw

In a method to make it simpler to do effects like shadow, outline

DrawStringInternal_RuntimeCache

(
    FCanvas* InCanvas,
    const FVector2D& DrawPos,
    const FLinearColor& DrawColor
)

GetFontCacheType()

Get the type of font cache the UFont is using

Overridden from FCanvasTextItemBase

	Name	Description
void	DrawStringInternal ( FCanvas* InCanvas, const FVector2D& DrawPos, const FLinearColor& DrawColor )	Internal string draw In a method to make it simpler to do effects like shadow, outline
ESimpleEleme...	GetTextBlendMode ( const bool bHasShadow )	Get the blend mode we should use to draw this text
FVector2D	GetTextSize ( float DPIScale )	Get the measured size of the text to draw
bool	HasValidText()	Does this text item have valid text to draw?

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss