UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FCanvasItem Class Referenceabstract

#include <CanvasItem.h>

+ Inheritance diagram for FCanvasItem:

Public Member Functions

 FCanvasItem (const FVector2D &InPosition)
 
virtual ~FCanvasItem ()
 
virtual void Draw (FCanvas *InCanvas)=0
 
virtual void Draw (FCanvas *InCanvas, const FVector2D &InPosition)
 
virtual void Draw (FCanvas *InCanvas, float X, float Y)
 
virtual void SetColor (const FLinearColor &InColor)
 

Public Attributes

FVector2D Position
 
uint32 StereoDepth
 
ESimpleElementBlendMode BlendMode
 
bool bFreezeTime
 
FBatchedElementParametersBatchedElementParameters
 

Protected Attributes

FLinearColor Color
 

Constructor & Destructor Documentation

◆ FCanvasItem()

FCanvasItem::FCanvasItem ( const FVector2D InPosition)
inline

Basic render item.

Parameters
InPositionDraw position

◆ ~FCanvasItem()

virtual FCanvasItem::~FCanvasItem ( )
inlinevirtual

Member Function Documentation

◆ Draw() [1/3]

◆ Draw() [2/3]

virtual void FCanvasItem::Draw ( FCanvas InCanvas,
const FVector2D InPosition 
)
inlinevirtual

Draw this item (this will affect the items position for future draw calls that do no specify a position)

Parameters
InCanvasCanvas on which to draw
InPositionDraw position - this will not preserve the items position

Reimplemented in FCanvasTileItem, FCanvasBorderItem, FCanvasTextItemBase, FCanvasBoxItem, FCanvasDashedBoxItem, FCanvasTriangleItem, and FCanvasLineItem.

◆ Draw() [3/3]

virtual void FCanvasItem::Draw ( FCanvas InCanvas,
float  X,
float  Y 
)
inlinevirtual

Draw this item (this will affect the items position for future draw calls that do no specify a position)

Parameters
InCanvasCanvas on which to draw
XX Draw position
YY Draw position

Reimplemented in FCanvasLineItem, FCanvasTileItem, FCanvasBorderItem, FCanvasTextItemBase, FCanvasBoxItem, FCanvasDashedBoxItem, and FCanvasTriangleItem.

◆ SetColor()

virtual void FCanvasItem::SetColor ( const FLinearColor InColor)
inlinevirtual

Member Data Documentation

◆ BatchedElementParameters

FBatchedElementParameters* FCanvasItem::BatchedElementParameters

◆ bFreezeTime

bool FCanvasItem::bFreezeTime

◆ BlendMode

ESimpleElementBlendMode FCanvasItem::BlendMode

◆ Color

FLinearColor FCanvasItem::Color
protected

◆ Position

FVector2D FCanvasItem::Position

◆ StereoDepth

uint32 FCanvasItem::StereoDepth

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