Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > FCanvas > FCanvas::GetBatchedElements

Light Theme

Dark Theme

FCanvas::GetBatchedElements

Returns a [FBatchedElements](API\Runtime\Engine\FBatchedElements) pointer to be used for adding vertices and primitives for rendering.

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/CanvasTypes.h
Include	#include "CanvasTypes.h"
Source	/Engine/Source/Runtime/Engine/Private/UserInterface/Canvas.cpp

Syntax

FBatchedElements * GetBatchedElements
(
    EElementType InElementType,
    FBatchedElementParameters * InBatchedElementParameters,
    const FTexture * Texture,
    ESimpleElementBlendMode BlendMode,
    const FDepthFieldGlowInfo & GlowInfo,
    bool bApplyDPIScale
)

Remarks

Returns a FBatchedElements pointer to be used for adding vertices and primitives for rendering. Adds a new render item to the sort element entry based on the current sort key.

Returns

Returns a pointer to a FBatchedElements object.

Parameters

Parameter	Description
InElementType	Type of element we are going to draw.
InBatchedElementParameters	Parameters for this element
InTexture	New texture that will be set.
InBlendMode	New blendmode that will be set.
GlowInfo	info for optional glow effect when using depth field rendering

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss