UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Canvas.cpp File Reference

Classes

class  FRDGCanvasRenderTarget
 

Namespaces

namespace  DisplayDebugManagerCvars
 

Functions

 DEFINE_LOG_CATEGORY_STATIC (LogCanvas, Log, All)
 
 DEFINE_STAT (STAT_Canvas_FlushTime)
 
 DEFINE_STAT (STAT_Canvas_DrawTextureTileTime)
 
 DEFINE_STAT (STAT_Canvas_DrawMaterialTileTime)
 
 DEFINE_STAT (STAT_Canvas_DrawStringTime)
 
 DEFINE_STAT (STAT_Canvas_WordWrappingTime)
 
 DEFINE_STAT (STAT_Canvas_GetBatchElementsTime)
 
 DEFINE_STAT (STAT_Canvas_AddTileRenderTime)
 
 DEFINE_STAT (STAT_Canvas_AddTriangleRenderTime)
 
 DEFINE_STAT (STAT_Canvas_NumBatchesCreated)
 
FTextureGetTextureForCanvasItem (UTexture *RenderTexture)
 
ENGINE_API void StringSize (const UFont *Font, int32 &XL, int32 &YL, FStringView Text)
 

Function Documentation

◆ DEFINE_LOG_CATEGORY_STATIC()

DEFINE_LOG_CATEGORY_STATIC ( LogCanvas  ,
Log  ,
All   
)

◆ DEFINE_STAT() [1/9]

DEFINE_STAT ( STAT_Canvas_AddTileRenderTime  )

◆ DEFINE_STAT() [2/9]

◆ DEFINE_STAT() [3/9]

◆ DEFINE_STAT() [4/9]

DEFINE_STAT ( STAT_Canvas_DrawStringTime  )

◆ DEFINE_STAT() [5/9]

◆ DEFINE_STAT() [6/9]

DEFINE_STAT ( STAT_Canvas_FlushTime  )

◆ DEFINE_STAT() [7/9]

◆ DEFINE_STAT() [8/9]

DEFINE_STAT ( STAT_Canvas_NumBatchesCreated  )

◆ DEFINE_STAT() [9/9]

DEFINE_STAT ( STAT_Canvas_WordWrappingTime  )

◆ GetTextureForCanvasItem()

FTexture * GetTextureForCanvasItem ( UTexture RenderTexture)

◆ StringSize()

ENGINE_API void StringSize ( const UFont Font,
int32 XL,
int32 YL,
FStringView  Text 
)

Render string using both a font and a material. The material should have a font exposed as a parameter so that the correct font page can be set based on the character being drawn.

Parameters
Font- font containing texture pages of character glyphs
XL- out width
YL- out height
Text- string of text to be measured