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

#include <CanvasRendererItem.h>

+ Inheritance diagram for FCanvasTriangleRendererItem:

Public Member Functions

 FCanvasTriangleRendererItem (ERHIFeatureLevel::Type InFeatureLevel, const FMaterialRenderProxy *InMaterialRenderProxy=NULL, const FCanvas::FTransformEntry &InTransform=FCanvas::FTransformEntry(FMatrix::Identity), bool bInFreezeTime=false)
 
virtual class FCanvasTriangleRendererItem * GetCanvasTriangleRendererItem () 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 AddTriangle (const FCanvasUVTri &Tri, FHitProxyId HitProxyId)
 
void AddReserveTriangles (int32 NumTriangles)
 
void ReserveTriangles (int32 NumTriangles)
 
- Public Member Functions inherited from FCanvasBaseRenderItem
virtual ~FCanvasBaseRenderItem ()
 
virtual class FCanvasBatchedElementRenderItem * GetCanvasBatchedElementRenderItem ()
 
virtual class FCanvasTileRendererItem * GetCanvasTileRendererItem ()
 

Detailed Description

Info needed to render a single FTriangleRenderer

Constructor & Destructor Documentation

◆ FCanvasTriangleRendererItem()

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

Init constructor

Member Function Documentation

◆ AddReserveTriangles()

void FCanvasTriangleRendererItem::AddReserveTriangles ( int32  NumTriangles)
inline

Reserves space in array for NumTriangles new triangles.

Parameters
NumTrianglesAdditional number of triangles to reserve space for.

◆ AddTriangle()

int32 FCanvasTriangleRendererItem::AddTriangle ( const FCanvasUVTri &  Tri,
FHitProxyId  HitProxyId 
)
inline

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

Parameters
returnnumber of triangles added

◆ GetCanvasTriangleRendererItem()

virtual class FCanvasTriangleRendererItem * FCanvasTriangleRendererItem::GetCanvasTriangleRendererItem ( )
inlineoverridevirtual

FCanvasTriangleRendererItem instance accessor

Returns
this instance

Reimplemented from FCanvasBaseRenderItem.

◆ IsMatch()

bool FCanvasTriangleRendererItem::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 FCanvasTriangleRendererItem::Render_GameThread ( const FCanvas *  Canvas,
FCanvasRenderThreadScope &  RenderScope 
)
overridevirtual

Renders the canvas item. Iterates over each triangle 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 FCanvasTriangleRendererItem::Render_RenderThread ( FCanvasRenderContext &  RenderContext,
FMeshPassProcessorRenderState &  DrawRenderState,
const FCanvas *  Canvas 
)
overridevirtual

Renders the canvas item. Iterates over each triangle 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.

◆ ReserveTriangles()

void FCanvasTriangleRendererItem::ReserveTriangles ( int32  NumTriangles)
inline

Reserves space in array for at least NumTriangles total triangles.

Parameters
NumTrianglesAdditional number of triangles to reserve space for.
The documentation for this class was generated from the following files: