1. Epic GamesDeveloper
  3. UCanvas

UCanvas

A drawing canvas.

API > API/Runtime > API/Runtime/Engine

A drawing canvas.

   
Name UCanvas
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Engine/Canvas.h
Include Path #include "Engine/Canvas.h"

Syntax

UCLASS (Transient, BlueprintType, MinimalAPI)  
class UCanvas : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCanvas ( const FObjectInitializer& ObjectInitializer
)

   Engine/Canvas.h  

Enums

Public

Name Remarks
ELastCharacterIndexFormat  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCenterX uint32   Engine/Canvas.h  
bCenterY uint32   Engine/Canvas.h  
bNoSmooth uint32   Engine/Canvas.h  
CachedDisplayHeight int32   Engine/Canvas.h  
CachedDisplayWidth int32   Engine/Canvas.h  
Canvas FCanvas *   Engine/Canvas.h  
ClipX float   Engine/Canvas.h  
ClipY float   Engine/Canvas.h  
ColorModulate FPlane Internal. Engine/Canvas.h  
DefaultTexture TObjectPtr< class UTexture2D >   Engine/Canvas.h  
DisplayDebugManager FDisplayDebugManager   Engine/Canvas.h  
DrawColor FColor   Engine/Canvas.h  
GradientTexture0 TObjectPtr< class UTexture2D >   Engine/Canvas.h  
HmdOrientation FQuat   Engine/Canvas.h  
OrgX float Modifiable properties. Engine/Canvas.h  
OrgY float   Engine/Canvas.h  
ReporterGraph TObjectPtr< class UReporterGraph > Helper class to render 2d graphs on canvas Engine/Canvas.h  
SafeZonePadEX int32   Engine/Canvas.h  
SafeZonePadEY int32   Engine/Canvas.h  
SafeZonePadX int32 Cached data for safe zone calculation. Engine/Canvas.h  
SafeZonePadY int32   Engine/Canvas.h  
SceneView FSceneView *   Engine/Canvas.h  
SizeX int32   Engine/Canvas.h  
SizeY int32   Engine/Canvas.h  
UnsafeSizeX int32   Engine/Canvas.h  
UnsafeSizeY int32   Engine/Canvas.h  
ViewProjectionMatrix FMatrix   Engine/Canvas.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Applies the current Platform's safe zone to the current Canvas position. Engine/Canvas.h  

FFontRenderInfo CreateFontRenderInfo ( bool bClipText,
bool bEnableShadow,
FLinearColor GlowColor,
FVector2D GlowOuterRadius,
FVector2D GlowInnerRadius
)

 Constructor for FontRenderInfo Engine/Canvas.h  

void Deproject ( FVector2D ScreenPos,
FVector& WorldOrigin,
FVector& WorldDirection
) const

 Transforms 2D screen coordinates into a 3D world-space origin and direction. Engine/Canvas.h  

virtual void DrawDebugGraph ( const FString& Title,
float ValueX,
float ValueY,
float UL_X,
float UL_Y,
float W,
float H,
FVector2D RangeX,
FVector2D RangeY
)

 Draws a graph comparing 2 variables. Useful for visual debugging and tweaking. Engine/Canvas.h  

void DrawIcon ( FCanvasIcon Icon,
float X,
float Y,
float Scale
)

 Draw a CanvasIcon at the desired canvas position. Engine/Canvas.h  

void DrawItem ( FCanvasItem& Item,
float X,
float Y
)

 Draw a CanvasItem at the given coordinates Engine/Canvas.h  

void DrawItem ( FCanvasItem& Item,
const FVector2D& InPosition
)

 Draw a CanvasItem at the given coordinates Engine/Canvas.h  

void DrawItem ( FCanvasItem& Item
)

 Draw a CanvasItem Engine/Canvas.h  

void DrawScaledIcon ( FCanvasIcon Icon,
float X,
float Y,
FVector Scale
)

 Draw a scaled CanvasIcon at the desired canvas position. Engine/Canvas.h  

float DrawText ( const UFont* InFont,
FAnsiStringView InText,
float X,
float Y,
float XScale,
float YScale,
const FFontRenderInfo& RenderInfo
)

   Engine/Canvas.h  

float DrawText ( const UFont* InFont,
FStringView InText,
float X,
float Y,
float XScale,
float YScale,
const FFontRenderInfo& RenderInfo
)

 Draws a string of text to the screen. Engine/Canvas.h  

float DrawText ( const UFont* InFont,
const FText& InText,
float X,
float Y,
float XScale,
float YScale,
const FFontRenderInfo& RenderInfo
)

   Engine/Canvas.h  

void DrawTile ( UTexture* Tex,
float X,
float Y,
float XL,
float YL,
float U,
float V,
float UL,
float VL,
EBlendMode BlendMode
)

 Draw arbitrary aligned rectangle. Engine/Canvas.h  

void GetCenter ( float& outX,
float& outY
) const

 Return X,Y for center of the draw region. Engine/Canvas.h  

void GetCenter ( double& outX,
double& outY
) const

   Engine/Canvas.h  

float GetDPIScale()

   Engine/Canvas.h  

TWeakObjectPtr< class UReporterGraph > GetReporterGraph()

 Creates if necessary and returns ReporterGraph instance for 2d graph canvas drawing Engine/Canvas.h  

void Init ( int32 InSizeX,
int32 InSizeY,
FSceneView* InSceneView,
FCanvas* InCanvas
)

 Initializes the canvas. Engine/Canvas.h  

void K2_Deproject ( FVector2D ScreenPosition,
FVector& WorldOrigin,
FVector& WorldDirection
)

 Performs a deprojection of a screen space coordinate using the projection matrix set up for the Canvas. Engine/Canvas.h
  • BlueprintCallable
  • Category=Canvas
  • Meta=(DisplayName="Deproject", ScriptName="Deproject")

void K2_DrawBorder ( UTexture* BorderTexture,
UTexture* BackgroundTexture,
UTexture* LeftBorderTexture,
UTexture* RightBorderTexture,
UTexture* TopBorderTexture,
UTexture* BottomBorderTexture,
FVector2D ScreenPosition,
FVector2D ScreenSize,
FVector2D CoordinatePosition,
FVector2D CoordinateSize,
FLinearColor RenderColor,
FVector2D BorderScale,
FVector2D BackgroundScale,
float Rotation,
FVector2D PivotPoint,
FVector2D CornerSize
)

 Draws a 3x3 grid border with tiled frame and tiled interior on the Canvas. Engine/Canvas.h
  • BlueprintCallable
  • Category=Canvas
  • Meta=(DisplayName="Draw Border", ScriptName="DrawBorder")

void K2_DrawBox ( FVector2D ScreenPosition,
FVector2D ScreenSize,
float Thickness,
FLinearColor RenderColor
)

 Draws an unfilled box on the Canvas. Engine/Canvas.h
  • BlueprintCallable
  • Category=Canvas
  • Meta=(DisplayName="Draw Box", ScriptName="DrawBox")

void K2_DrawLine ( FVector2D ScreenPositionA,
FVector2D ScreenPositionB,
float Thickness,
FLinearColor RenderColor
)

 Draws a line on the Canvas. Engine/Canvas.h
  • BlueprintCallable
  • Category=Canvas
  • Meta=(DisplayName="Draw Line", ScriptName="DrawLine")

void K2_DrawMaterial ( UMaterialInterface* RenderMaterial,
FVector2D ScreenPosition,
FVector2D ScreenSize,
FVector2D CoordinatePosition,
FVector2D CoordinateSize,
float Rotation,
FVector2D PivotPoint
)

 Draws a material on the Canvas. Engine/Canvas.h
  • BlueprintCallable
  • Category=Canvas
  • Meta=(DisplayName="Draw Material", ScriptName="DrawMaterial")

void K2_DrawMaterialTriangle ( UMaterialInterface* RenderMaterial,
TArray< FCanvasUVTri > Triangles
)

 Draws a set of triangles on the Canvas. Engine/Canvas.h
  • BlueprintCallable
  • Category=Canvas
  • Meta=(DisplayName="Draw Material Triangles", ScriptName="DrawMaterialTriangles")

void K2_DrawPolygon ( UTexture* RenderTexture,
FVector2D ScreenPosition,
FVector2D Radius,
int32 NumberOfSides,
FLinearColor RenderColor
)

 Draws a polygon on the Canvas. Engine/Canvas.h
  • BlueprintCallable
  • Category=Canvas
  • Meta=(DisplayName="Draw Polygon", ScriptName="DrawPolygon")

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
)

 Draws text on the Canvas. Engine/Canvas.h
  • BlueprintCallable
  • Category=Canvas
  • Meta=(DisplayName="Draw Text", ScriptName="DrawText")

void K2_DrawTexture ( UTexture* RenderTexture,
FVector2D ScreenPosition,
FVector2D ScreenSize,
FVector2D CoordinatePosition,
FVector2D CoordinateSize,
FLinearColor RenderColor,
EBlendMode BlendMode,
float Rotation,
FVector2D PivotPoint
)

 Draws a texture on the Canvas. Engine/Canvas.h
  • BlueprintCallable
  • Category=Canvas
  • Meta=(DisplayName="Draw Texture", ScriptName="DrawTexture")

void K2_DrawTriangle ( UTexture* RenderTexture,
TArray< FCanvasUVTri > Triangles
)

 Draws a set of triangles on the Canvas. Engine/Canvas.h
  • BlueprintCallable
  • Category=Canvas
  • Meta=(DisplayName="Draw Triangles", ScriptName="DrawTriangles")

FVector K2_Project ( FVector WorldLocation
)

 Performs a projection of a world space coordinates using the projection matrix set up for the Canvas. Engine/Canvas.h
  • BlueprintCallable
  • Category=Canvas
  • Meta=(DisplayName="Project", ScriptName="Project")

FVector2D K2_StrLen ( UFont* RenderFont,
const FString& RenderText
)

 Returns the wrapped text size in screen space coordinates. Engine/Canvas.h
  • BlueprintCallable
  • Category=Canvas
  • Meta=(DisplayName="Wrapped Text Size", ScriptName="WrappedTextSize")

FVector2D K2_TextSize ( UFont* RenderFont,
const FString& RenderText,
FVector2D Scale
)

 Returns the clipped text size in screen space coordinates. Engine/Canvas.h  

void PopSafeZoneTransform()

   Engine/Canvas.h  

FVector Project ( FVector Location,
bool bClampToZeroPlane
) const

 Transforms a 3D world-space vector into 2D screen coordinates. Engine/Canvas.h  

virtual void Reset ( bool bKeepOrigin
)

 Reset canvas parameters, optionally do not change the origin Engine/Canvas.h  

void SetClip ( float X,
float Y
)

 Sets the position of the lower-left corner of the clipping region of the Canvas Engine/Canvas.h  

void SetDrawColor ( uint8 R,
uint8 G,
uint8 B,
uint8 A
)

 Set draw color. (R,G,B,A) Engine/Canvas.h  

void SetDrawColor ( FColor const& C
)

 Set draw color. (FColor) Engine/Canvas.h  

void SetLinearDrawColor ( FLinearColor InColor,
float OpacityOverride
)

 Set DrawColor with a FLinearColor and optional opacity override Engine/Canvas.h  

void SetView ( FSceneView* InView
)

 Changes the view for the canvas. Engine/Canvas.h  

void StrLen ( const UFont* InFont,
FAnsiStringView InText,
double& XL,
double& YL,
bool bDPIAware
)

   Engine/Canvas.h  

void StrLen ( const UFont* InFont,
FStringView InText,
float& XL,
float& YL,
bool bDPIAware
)

 Calculate the length of a string, taking text wrapping into account. Engine/Canvas.h  

void StrLen ( const UFont* InFont,
FStringView InText,
double& XL,
double& YL,
bool bDPIAware
)

   Engine/Canvas.h  

void StrLen ( const UFont* InFont,
FAnsiStringView InText,
float& XL,
float& YL,
bool bDPIAware
)

   Engine/Canvas.h  

void TextSize ( const UFont* InFont,
FAnsiStringView InText,
double& XL,
double& YL,
double ScaleX,
double ScaleY
)

   Engine/Canvas.h  

void TextSize ( const UFont* InFont,
FAnsiStringView InText,
float& XL,
float& YL,
float ScaleX,
float ScaleY
)

   Engine/Canvas.h  

void TextSize ( const UFont* InFont,
FStringView InText,
float& XL,
float& YL,
float ScaleX,
float ScaleY
)

 Calculates the horizontal and vertical size of a given string. Engine/Canvas.h  

void TextSize ( const UFont* InFont,
FStringView InText,
double& XL,
double& YL,
double ScaleX,
double ScaleY
)

   Engine/Canvas.h  

void Update()

 Updates the canvas. Engine/Canvas.h  

void UpdateSafeZoneData()

 Updates cached SafeZone data from the device. Call when main device is resized. Engine/Canvas.h  

int32 WrappedPrint ( bool Draw,
float X,
float Y,
int32& out_XL,
int32& out_YL,
const UFont* Font,
float ScaleX,
float ScaleY,
bool bCenterTextX,
bool bCenterTextY,
FStringView Text,
const FFontRenderInfo& RenderInfo
)

 Compute size and optionally print text with word wrap. Engine/Canvas.h  

void WrappedStrLenf ( const UFont* Font,
float ScaleX,
float ScaleY,
int32& XL,
int32& YL,
const TCHAR* Fmt,
...
)

 Calculate the size of a string built from a font, word wrapped to a specified region. Engine/Canvas.h  

void WrapString ( FTextSizingParameters& Parameters,
const float InCurX,
FStringView Text,
TArray< FWrappedStringElement >& out_Lines,
FCanvasWordWrapper::FWrappedLineData*const OutWrappedLineData
)

   Engine/Canvas.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Engine/Canvas.h  

Static

Name Remarks Include Path Unreal Specifiers

static void CanvasStringSize ( FTextSizingParameters& Parameters,
FStringView Text
)

 Calculates the size of the specified string. Engine/Canvas.h  

static void ClippedStrLen ( const UFont* Font,
float ScaleX,
float ScaleY,
int32& XL,
int32& YL,
FStringView Text
)

 Calculate the length of a string. Engine/Canvas.h  

static FCanvasIcon MakeIcon ( UTexture* Texture,
float U,
float V,
float UL,
float VL
)

 Fake CanvasIcon constructor. Engine/Canvas.h  

static void MeasureStringInternal ( FTextSizingParameters& Parameters,
const TCHAR*const Text,
const int32 TextLength,
const int32 StopAfterHorizontalOffset,
const ELastCharacterIndexFormat CharIndexFormat,
int32& OutLastCharacterIndex
)

   Engine/Canvas.h  

static void MeasureStringInternal ( FTextSizingParameters& Parameters,
FStringView Text,
const int32 StopAfterHorizontalOffset,
const ELastCharacterIndexFormat CharIndexFormat,
int32& OutLastCharacterIndex
)

 Measures a string, optionally stopped after the specified horizontal offset in pixels is reached. Engine/Canvas.h  

static void StrLen ( const UFont* InFont,
FStringView InText,
float& XL,
float& YL,
bool bDPIAware,
FCanvas* InCanvas
)

 Calculate the length of a string, taking text wrapping into account. Engine/Canvas.h  

static void StrLen ( const UFont* InFont,
FStringView InText,
double& XL,
double& YL,
bool bDPIAware,
FCanvas* InCanvas
)

   Engine/Canvas.h  

static void StrLen ( const UFont* InFont,
FAnsiStringView InText,
float& XL,
float& YL,
bool bDPIAware,
FCanvas* InCanvas
)

   Engine/Canvas.h  

static void StrLen ( const UFont* InFont,
FAnsiStringView InText,
double& XL,
double& YL,
bool bDPIAware,
FCanvas* InCanvas
)

   Engine/Canvas.h  

static void UpdateAllCanvasSafeZoneData()

 Function to go through all constructed canvas items and update their safe zone data. Engine/Canvas.h  

static void WrapString ( FCanvasWordWrapper& Wrapper,
FTextSizingParameters& Parameters,
const float InCurX,
FStringView Text,
TArray< FWrappedStringElement >& out_Lines,
FCanvasWordWrapper::FWrappedLineData*const OutWrappedLineData
)

 Parses a single string into an array of strings that will fit inside the specified bounding region. Engine/Canvas.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page