FCanvasTextItemBase | Unreal Engine 5.7 Documentation

Base item used for drawing text


Name	FCanvasTextItemBase
Type	class
Header File	/Engine/Source/Runtime/Engine/Public/CanvasItem.h
Include Path	#include "CanvasItem.h"

Syntax

class FCanvasTextItemBase : public FCanvasItem

Name	Remarks	Include Path	Unreal Specifiers
FCanvasTextItemBase ( const FVector2D& InPosition, const FLinearColor& InColor )		CanvasItem.h

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FCanvasTextItemBase()		CanvasItem.h

Name	Remarks
FTextEffect

Name	Type	Remarks	Include Path
bCentreX	bool	Centre the text in the viewport on horizontally.	CanvasItem.h
bCentreY	bool	Centre the text in the viewport on vertically.	CanvasItem.h
bDontCorrectStereoscopic	bool	Disables correction of font render issue when using stereoscopic display.	CanvasItem.h
bOutlined	bool	Draw an outline on the text.	CanvasItem.h
Depth	float	Depth sort key.	CanvasItem.h
DrawnSize	FVector2D	The size of the drawn text after the draw call.	CanvasItem.h
FontRenderInfo	FFontRenderInfo	Custom font render information.	CanvasItem.h
HorizSpacingAdjust	float	Horizontal spacing adjustment.	CanvasItem.h
OutlineColor	FLinearColor	The color of the outline.	CanvasItem.h
Scale	FVector2D	The scale of the text	CanvasItem.h
ShadowColor	FLinearColor	The color of the shadow	CanvasItem.h
ShadowOffset	FVector2D	The offset of the shadow.	CanvasItem.h

Name	Remarks	Include Path	Unreal Specifiers
void DisableShadow()	Disable the shadow	CanvasItem.h
void EnableShadow ( const FLinearColor& InColor, const FVector2D& InOffset )	Set the shadow offset and color.	CanvasItem.h

Name	Remarks	Include Path
virtual void Draw ( FCanvas* InCanvas )	Draw the item at the given coordinates.	CanvasItem.h
virtual void Draw ( FCanvas* InCanvas, const FVector2D& InPosition )	Expose the functions defined in the base class.	CanvasItem.h
virtual void Draw ( FCanvas* InCanvas, float X, float Y )	Expose the functions defined in the base class.	CanvasItem.h
virtual void SetColor ( const FLinearColor& InColor )	Set the Color of the item.	CanvasItem.h

Name	Remarks	Include Path
void DrawStringInternal ( FCanvas* InCanvas, const FVector2D& DrawPos, const FLinearColor& DrawColor, TArrayView< FTextEffect > Offsets )	Internal string drawIn a method to make it simpler to do effects like shadow, outline	CanvasItem.h
ESimpleElementBlendMode GetTextBlendMode ( const bool bHasShadow ) const	Get the blend mode we should use to draw this text	CanvasItem.h
FVector2D GetTextSize ( float DPIScale ) const	Get the measured size of the text to draw	CanvasItem.h
bool HasValidText()	Does this text item have valid text to draw?	CanvasItem.h