FCanvasTextItem Class Reference

#include <CanvasItem.h>

Inheritance diagram for FCanvasTextItem:

Public Member Functions
ENGINE_API	FCanvasTextItem (const FVector2D &InPosition, const FText &InText, const UFont *InFont, const FLinearColor &InColor)
ENGINE_API	FCanvasTextItem (const FVector2D &InPosition, const FText &InText, const FSlateFontInfo &InFontInfo, const FLinearColor &InColor)
virtual ENGINE_API	~FCanvasTextItem ()
Public Member Functions inherited from FCanvasSimpleTextItem
	FCanvasSimpleTextItem (const FVector2D &InPosition, const UFont *InFont, const FLinearColor &InColor)
	FCanvasSimpleTextItem (const FVector2D &InPosition, const FSlateFontInfo &InFontInfo, const FLinearColor &InColor)
virtual	~FCanvasSimpleTextItem () override=default
Public Member Functions inherited from FCanvasTextItemBase
ENGINE_API	FCanvasTextItemBase (const FVector2D &InPosition, const FLinearColor &InColor)
virtual ENGINE_API	~FCanvasTextItemBase ()
void	EnableShadow (const FLinearColor &InColor, const FVector2D &InOffset=FVector2D(1.0f, 1.0f))
void	DisableShadow ()
virtual ENGINE_API void	Draw (FCanvas *InCanvas) override
virtual void	SetColor (const FLinearColor &InColor) override final
virtual void	Draw (FCanvas *InCanvas)=0
virtual void	Draw (FCanvas *InCanvas, const FVector2D &InPosition)
virtual void	Draw (FCanvas *InCanvas, float X, float Y)
Public Member Functions inherited from FCanvasItem
	FCanvasItem (const FVector2D &InPosition)
virtual	~FCanvasItem ()

Public Attributes
FText	Text
Public Attributes inherited from FCanvasSimpleTextItem
const UFont *	Font
TOptional< FSlateFontInfo >	SlateFontInfo
Public Attributes inherited from FCanvasTextItemBase
float	HorizSpacingAdjust
float	Depth
FFontRenderInfo	FontRenderInfo
FLinearColor	ShadowColor
FVector2D	ShadowOffset
FVector2D	DrawnSize
bool	bCentreX
bool	bCentreY
bool	bOutlined
FLinearColor	OutlineColor
bool	bDontCorrectStereoscopic
FVector2D	Scale
Public Attributes inherited from FCanvasItem
FVector2D	Position
uint32	StereoDepth
ESimpleElementBlendMode	BlendMode
bool	bFreezeTime
FBatchedElementParameters *	BatchedElementParameters

Protected Member Functions
virtual ENGINE_API bool	HasValidText () const override
virtual ENGINE_API FVector2D	GetTextSize (float DPIScale) const override
virtual ENGINE_API void	DrawStringInternal (FCanvas *InCanvas, const FVector2D &DrawPos, const FLinearColor &DrawColor, TArrayView< FTextEffect > TextEffects) override
ENGINE_API void	DrawStringInternal_OfflineCache (FCanvas *InCanvas, const FVector2D &DrawPos, const FLinearColor &DrawColor, TArrayView< FTextEffect > TextEffects)
ENGINE_API void	DrawStringInternal_RuntimeCache (FCanvas *InCanvas, const FVector2D &DrawPos, const FLinearColor &DrawColor, TArrayView< FTextEffect > TextEffects)
Protected Member Functions inherited from FCanvasSimpleTextItem
ENGINE_API EFontCacheType	GetFontCacheType () const
virtual ENGINE_API ESimpleElementBlendMode	GetTextBlendMode (const bool bHasShadow) const override
ENGINE_API FVector2D	GetTextSizeInternal (FStringView Text, float DPIScale) const
ENGINE_API void	DrawStringInternal (FCanvas *InCanvas, FStringView Text, const FVector2D &DrawPos, const FLinearColor &DrawColor, TArrayView< FTextEffect > TextEffects)
ENGINE_API void	DrawStringInternal_OfflineCache (FCanvas *InCanvas, FStringView Text, const FVector2D &DrawPos, const FLinearColor &DrawColor, TArrayView< FTextEffect > TextEffects)
ENGINE_API void	DrawStringInternal_RuntimeCache (FCanvas *InCanvas, FStringView Text, const FVector2D &DrawPos, const FLinearColor &DrawColor, TArrayView< FTextEffect > TextEffects)

Additional Inherited Members
Protected Attributes inherited from FCanvasTextItemBase
FCanvasTileItem	TileItem
FBatchedElements *	BatchedElements
Protected Attributes inherited from FCanvasItem
FLinearColor	Color

Constructor & Destructor Documentation

FCanvasTextItem() [1/2]

FCanvasTextItem::FCanvasTextItem	(	const FVector2D &	InPosition,
		const FText &	InText,
		const UFont *	InFont,
		const FLinearColor &	InColor
	)

Constructor.

Parameters

InPosition	Draw position.
InText	String to draw.
InFont	Font to draw with.
InColor	Color to draw the text with.

FCanvasTextItem() [2/2]

FCanvasTextItem::FCanvasTextItem	(	const FVector2D &	InPosition,
		const FText &	InText,
		const FSlateFontInfo &	InFontInfo,
		const FLinearColor &	InColor
	)

Constructor

Parameters

InPosition	Draw position.
InText	String to draw.
InFontInfo	Font info to draw with.
InColor	Color to draw the text with.

~FCanvasTextItem()

FCanvasTextItem::~FCanvasTextItem ( )

virtualdefault

Member Function Documentation

DrawStringInternal()

void FCanvasTextItem::DrawStringInternal ( FCanvas *  InCanvas, const FVector2D &  DrawPos, const FLinearColor &  DrawColor, TArrayView< FTextEffect >  Offsets  )

overrideprotectedvirtual

Internal string draw

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

Implements FCanvasSimpleTextItem.

DrawStringInternal_OfflineCache()

void FCanvasTextItem::DrawStringInternal_OfflineCache ( FCanvas *  InCanvas, const FVector2D &  DrawPos, const FLinearColor &  DrawColor, TArrayView< FTextEffect >  TextEffects  )

protected

Internal string draw.

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

DrawStringInternal_RuntimeCache()

void FCanvasTextItem::DrawStringInternal_RuntimeCache ( FCanvas *  InCanvas, const FVector2D &  DrawPos, const FLinearColor &  DrawColor, TArrayView< FTextEffect >  TextEffects  )

protected

GetTextSize()

FVector2D FCanvasTextItem::GetTextSize ( float  DPIScale ) const

overrideprotectedvirtual

Get the measured size of the text to draw

Implements FCanvasSimpleTextItem.

HasValidText()

bool FCanvasTextItem::HasValidText ( ) const

overrideprotectedvirtual

Does this text item have valid text to draw?

Implements FCanvasSimpleTextItem.

Member Data Documentation

Text

FText FCanvasTextItem::Text

---

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

• Engine/Source/Runtime/Engine/Public/CanvasItem.h
• Engine/Source/Runtime/Engine/Private/UserInterface/CanvasItem.cpp