FCanvasBatchedElementRenderItem

Info needed to render a batched element set

Windows
MacOS
Linux

Inheritance Hierarchy

FCanvasBaseRenderItem

FCanvasBatchedElementRenderItem

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/CanvasTypes.h

Include

#include "CanvasTypes.h"

Syntax

class FCanvasBatchedElementRenderItem : public FCanvasBaseRenderItem

Remarks

Info needed to render a batched element set

Constructors

Name Description

Public function

FCanvasBatchedElementRenderItem

(
    FBatchedElementParameters* InB...,
    const FTexture* InTexture,
    ESimpleElementBlendMode InBlendMode,
    FCanvas::EElementType InElementType,
    const FCanvas::FTransformEntry& In...,
    const FDepthFieldGlowInfo& InGlowI...
)

This data is deleted after rendering has completed

Destructors

Name Description

Public function Virtual

~FCanvasBatchedElementRenderItem()

Destructor to delete data in case nothing rendered

Functions

Name Description

Public function

FORCEINLINEF...

 

GetBatchedElements()

Accessor for the batched elements.

Public function

bool

 

IsMatch

(
    FBatchedElementParameters* Bat...,
    const FTexture* InTexture,
    ESimpleElementBlendMode InBlendMode,
    FCanvas::EElementType InElementType,
    const FCanvas::FTransformEntry& In...,
    const FDepthFieldGlowInfo& InGlowI...
)

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

Overridden from FCanvasBaseRenderItem

Name Description

Public function Virtual

FCanvasBatch...

 

GetCanvasBatchedElementRenderItem()

FCanvasBatchedElementRenderItem instance accessor

Public function Virtual

bool

 

Render_GameThread

(
    const FCanvas* Canvas,
    FRenderThreadScope& RenderScope
)

Renders the canvas item.

Public function Virtual

bool

 

Render_RenderThread

(
    FRHICommandListImmediate& RHICmdLi...,
    FMeshPassProcessorRenderState& Dra...,
    const FCanvas* Canvas
)

Renders the canvas item.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback