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

UCanvas::K2_DrawText

Draws text on the Canvas.

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Engine/Canvas.h
Include	#include "Engine/Canvas.h"
Source	/Engine/Source/Runtime/Engine/Private/UserInterface/Canvas.cpp

Syntax

void K2_DrawText
(
    UFont * RenderFont,
    const FString & RenderText,
    FVector2D ScreenPosition,
    FVector2D Scale,
    FLinearColor RenderColor,
    float Kerning,
    FLinearColor ShadowColor,
    FVector2D ShadowOffset,
    bool bCentreX,
    bool bCentreY,
    bool bOutlined,
    FLinearColor OutlineColor
)

Remarks

Draws text on the Canvas.

Parameters

Parameter	Description
RenderFont	Font to use when rendering the text. If this is null, then a default engine font is used.
RenderText	Text to render on the Canvas.
ScreenPosition	Screen space position to render the text.
RenderColor	Color to render the text.
Kerning	Horizontal spacing adjustment to modify the spacing between each letter.
ShadowColor	Color to render the shadow of the text.
ShadowOffset	Pixel offset relative to the screen space position to render the shadow of the text.
bCentreX	If true, then interpret the screen space position X coordinate as the center of the rendered text.
bCentreY	If true, then interpret the screen space position Y coordinate as the center of the rendered text.
bOutlined	If true, then the text should be rendered with an outline.
OutlineColor	Color to render the outline for the text.

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

Take our survey

Dismiss