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

#include <CanvasBatchedElementRenderItem.h>

+ Inheritance diagram for FCanvasBatchedElementRenderItem:

Public Member Functions

 FCanvasBatchedElementRenderItem (FBatchedElementParameters *InBatchedElementParameters=NULL, const FTexture *InTexture=NULL, ESimpleElementBlendMode InBlendMode=SE_BLEND_MAX, FCanvas::EElementType InElementType=FCanvas::ET_MAX, const FCanvas::FTransformEntry &InTransform=FCanvas::FTransformEntry(FMatrix::Identity), const FDepthFieldGlowInfo &InGlowInfo=FDepthFieldGlowInfo())
 
virtual ~FCanvasBatchedElementRenderItem ()
 
virtual class FCanvasBatchedElementRenderItem * GetCanvasBatchedElementRenderItem () 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 (FBatchedElementParameters *BatchedElementParameters, const FTexture *InTexture, ESimpleElementBlendMode InBlendMode, FCanvas::EElementType InElementType, const FCanvas::FTransformEntry &InTransform, const FDepthFieldGlowInfo &InGlowInfo)
 
FBatchedElements * GetBatchedElements ()
 
- Public Member Functions inherited from FCanvasBaseRenderItem
virtual ~FCanvasBaseRenderItem ()
 
virtual class FCanvasTileRendererItem * GetCanvasTileRendererItem ()
 
virtual class FCanvasTriangleRendererItem * GetCanvasTriangleRendererItem ()
 

Detailed Description

Info needed to render a batched element set

Constructor & Destructor Documentation

◆ FCanvasBatchedElementRenderItem()

FCanvasBatchedElementRenderItem::FCanvasBatchedElementRenderItem ( FBatchedElementParameters *  InBatchedElementParameters = NULL,
const FTexture *  InTexture = NULL,
ESimpleElementBlendMode  InBlendMode = SE_BLEND_MAX,
FCanvas::EElementType  InElementType = FCanvas::ET_MAX,
const FCanvas::FTransformEntry &  InTransform = FCanvas::FTransformEntry(FMatrix::Identity),
const FDepthFieldGlowInfo &  InGlowInfo = FDepthFieldGlowInfo() 
)
inline

Init constructor

◆ ~FCanvasBatchedElementRenderItem()

virtual FCanvasBatchedElementRenderItem::~FCanvasBatchedElementRenderItem ( )
inlinevirtual

Destructor to delete data in case nothing rendered

Member Function Documentation

◆ GetBatchedElements()

FBatchedElements * FCanvasBatchedElementRenderItem::GetBatchedElements ( )
inline

Accessor for the batched elements. This can be used for adding triangles and primitives to the batched elements

Returns
pointer to batched elements struct

◆ GetCanvasBatchedElementRenderItem()

virtual class FCanvasBatchedElementRenderItem * FCanvasBatchedElementRenderItem::GetCanvasBatchedElementRenderItem ( )
inlineoverridevirtual

FCanvasBatchedElementRenderItem instance accessor

Returns
this instance

Reimplemented from FCanvasBaseRenderItem.

◆ IsMatch()

bool FCanvasBatchedElementRenderItem::IsMatch ( FBatchedElementParameters *  BatchedElementParameters,
const FTexture *  InTexture,
ESimpleElementBlendMode  InBlendMode,
FCanvas::EElementType  InElementType,
const FCanvas::FTransformEntry &  InTransform,
const FDepthFieldGlowInfo &  InGlowInfo 
)
inline

Determine if this is a matching set by comparing texture,blendmode,elementype,transform. All must match

Parameters
BatchedElementParameters- parameters for this batched element
InTexture- texture resource for the item being rendered
InBlendMode- current alpha blend mode
InElementType- type of item being rendered: triangle,line,etc
InTransform- the transform for the item being rendered
InGlowInfo- the depth field glow of the item being rendered
Returns
true if the parameters match this render item

◆ Render_GameThread()

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

Renders the canvas item. Iterates over all batched elements and draws them with their own transforms

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

Implements FCanvasBaseRenderItem.

◆ Render_RenderThread()

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

Renders the canvas item. Iterates over all batched elements and draws them with their 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: