UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FCanvasBaseRenderItem Class Referenceabstract

#include <CanvasTypes.h>

+ Inheritance diagram for FCanvasBaseRenderItem:

Public Member Functions

virtual ~FCanvasBaseRenderItem ()
 
virtual bool Render_RenderThread (FCanvasRenderContext &RenderContext, FMeshPassProcessorRenderState &DrawRenderState, const FCanvas *Canvas)=0
 
virtual bool Render_GameThread (const FCanvas *Canvas, FCanvasRenderThreadScope &RenderScope)=0
 
virtual class FCanvasBatchedElementRenderItem * GetCanvasBatchedElementRenderItem ()
 
virtual class FCanvasTileRendererItem * GetCanvasTileRendererItem ()
 
virtual class FCanvasTriangleRendererItem * GetCanvasTriangleRendererItem ()
 

Detailed Description

Base interface for canvas items which can be batched for rendering

Constructor & Destructor Documentation

◆ ~FCanvasBaseRenderItem()

virtual FCanvasBaseRenderItem::~FCanvasBaseRenderItem ( )
inlinevirtual

Member Function Documentation

◆ GetCanvasBatchedElementRenderItem()

virtual class FCanvasBatchedElementRenderItem * FCanvasBaseRenderItem::GetCanvasBatchedElementRenderItem ( )
inlinevirtual

FCanvasBatchedElementRenderItem instance accessor

Returns
FCanvasBatchedElementRenderItem instance

Reimplemented in FCanvasBatchedElementRenderItem.

◆ GetCanvasTileRendererItem()

virtual class FCanvasTileRendererItem * FCanvasBaseRenderItem::GetCanvasTileRendererItem ( )
inlinevirtual

FCanvasTileRendererItem instance accessor

Returns
FCanvasTileRendererItem instance

Reimplemented in FCanvasTileRendererItem.

◆ GetCanvasTriangleRendererItem()

virtual class FCanvasTriangleRendererItem * FCanvasBaseRenderItem::GetCanvasTriangleRendererItem ( )
inlinevirtual

FCanvasTriangleRendererItem instance accessor

Returns
FCanvasTriangleRendererItem instance

Reimplemented in FCanvasTriangleRendererItem.

◆ Render_GameThread()

virtual bool FCanvasBaseRenderItem::Render_GameThread ( const FCanvas *  Canvas,
FCanvasRenderThreadScope &  RenderScope 
)
pure virtual

Renders the canvas item

Parameters
Canvas- canvas currently being rendered
Returns
true if anything rendered

Implemented in FCanvasBatchedElementRenderItem, FCanvasTileRendererItem, and FCanvasTriangleRendererItem.

◆ Render_RenderThread()

virtual bool FCanvasBaseRenderItem::Render_RenderThread ( FCanvasRenderContext &  RenderContext,
FMeshPassProcessorRenderState &  DrawRenderState,
const FCanvas *  Canvas 
)
pure virtual

Renders the canvas item

Parameters
RenderContext- the canvas render context to submit render passes to.
Canvas- canvas currently being rendered
Returns
true if anything rendered

Implemented in FCanvasBatchedElementRenderItem, FCanvasTileRendererItem, and FCanvasTriangleRendererItem.

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