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

#include <CanvasRendererItem.h>

+ Inheritance diagram for FCanvasTileRendererItem:

Public Member Functions

 FCanvasTileRendererItem (ERHIFeatureLevel::Type InFeatureLevel, const FMaterialRenderProxy *InMaterialRenderProxy=NULL, const FCanvas::FTransformEntry &InTransform=FCanvas::FTransformEntry(FMatrix::Identity), bool bInFreezeTime=false)
 
virtual class FCanvasTileRendererItem * GetCanvasTileRendererItem () override
 
virtual bool Render_RenderThread (FCanvasRenderContext &RenderContext, FMeshPassProcessorRenderState &DrawRenderState, const FCanvas *Canvas) override
 
virtual bool Render_GameThread (const FCanvas *Canvas, FCanvasRenderThreadScope &RenderScope) override
 
bool IsMatch (const FMaterialRenderProxy *InMaterialRenderProxy, const FCanvas::FTransformEntry &InTransform)
 
int32 AddTile (float X, float Y, float SizeX, float SizeY, float U, float V, float SizeU, float SizeV, FHitProxyId HitProxyId, FColor InColor)
 
- Public Member Functions inherited from FCanvasBaseRenderItem
virtual ~FCanvasBaseRenderItem ()
 
virtual class FCanvasBatchedElementRenderItem * GetCanvasBatchedElementRenderItem ()
 
virtual class FCanvasTriangleRendererItem * GetCanvasTriangleRendererItem ()
 

Detailed Description

Info needed to render a single FTileRenderer

Constructor & Destructor Documentation

◆ FCanvasTileRendererItem()

FCanvasTileRendererItem::FCanvasTileRendererItem ( ERHIFeatureLevel::Type  InFeatureLevel,
const FMaterialRenderProxy *  InMaterialRenderProxy = NULL,
const FCanvas::FTransformEntry &  InTransform = FCanvas::FTransformEntry(FMatrix::Identity),
bool  bInFreezeTime = false 
)
inline

Init constructor

Member Function Documentation

◆ AddTile()

int32 FCanvasTileRendererItem::AddTile ( float  X,
float  Y,
float  SizeX,
float  SizeY,
float  U,
float  V,
float  SizeU,
float  SizeV,
FHitProxyId  HitProxyId,
FColor  InColor 
)
inline

Add a new tile to the render data. These tiles all use the same transform and material proxy

Parameters
X- tile X offset
Y- tile Y offset
SizeX- tile X size
SizeY- tile Y size
U- tile U offset
V- tile V offset
SizeU- tile U size
SizeV- tile V size
returnnumber of tiles added

◆ GetCanvasTileRendererItem()

virtual class FCanvasTileRendererItem * FCanvasTileRendererItem::GetCanvasTileRendererItem ( )
inlineoverridevirtual

FCanvasTileRendererItem instance accessor

Returns
this instance

Reimplemented from FCanvasBaseRenderItem.

◆ IsMatch()

bool FCanvasTileRendererItem::IsMatch ( const FMaterialRenderProxy *  InMaterialRenderProxy,
const FCanvas::FTransformEntry &  InTransform 
)
inline

Determine if this is a matching set by comparing material,transform. All must match

Parameters
IInMaterialRenderProxy- material proxy resource for the item being rendered
InTransform- the transform for the item being rendered
Returns
true if the parameters match this render item

◆ Render_GameThread()

bool FCanvasTileRendererItem::Render_GameThread ( const FCanvas *  Canvas,
FCanvasRenderThreadScope &  RenderScope 
)
overridevirtual

Renders the canvas item. Iterates over each tile to be rendered and draws it with its own transforms

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

Implements FCanvasBaseRenderItem.

◆ Render_RenderThread()

bool FCanvasTileRendererItem::Render_RenderThread ( FCanvasRenderContext &  RenderContext,
FMeshPassProcessorRenderState &  DrawRenderState,
const FCanvas *  Canvas 
)
overridevirtual

Renders the canvas item. Iterates over each tile to be rendered and draws it with its own transforms

Parameters
Canvas- canvas currently being rendered
RHICmdList- command list to use
Returns
true if anything rendered

Implements FCanvasBaseRenderItem.

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