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 > SlateCore > Rendering > FSlateRenderBatch

Light Theme

Dark Theme

FSlateRenderBatch

Choose your operating system:

Windows

macOS

Linux

References

Module	SlateCore
Header	/Engine/Source/Runtime/SlateCore/Public/Rendering/SlateRenderBatch.h
Include	#include "Rendering/SlateRenderBatch.h"

Syntax

class FSlateRenderBatch

Variables

		Name	Description
	uint8: 1	bIsMergable	Whether or not the batch can be merged with others in the same layer
	uint8: 1	bIsMerged
	const FSlateCli...	ClippingState	The Stored clipping state for the corresponding clipping state index.
	ICustomSlateEle...	CustomDrawer
	ESlateDrawEffec...	DrawEffects
	ESlateBatchDraw...	DrawFlags
	ESlateDrawPrimi...	DrawPrimitiveType
	FVector2D	DynamicOffset	Dynamically modified offset that occurs when we have relative position stored render batches.
	int32	IndexOffset
	int32	InstanceCount
	ISlateUpdatable...	InstanceData
	int32	InstanceOffset
	int32	LayerId	The layer we need to sort by
	int32	NextBatchIndex
	int32	NumIndices	Number of indices in the batch
	int32	NumVertices	Number of vertices in the batch
	int8	SceneIndex
	FShaderParams	ShaderParams
	const FSlateSha...	ShaderResource	Shader Resource to use with this batch.
	ESlateShader	ShaderType
	FSlateIndexArra...	SourceIndices
	FSlateVertexArr...	SourceVertices	Source Data.
	int32	VertexOffset

Constructors

	Name	Description
	FSlateRenderBatch ( int32 InLayer, const FShaderParams& InShaderParam..., const FSlateShaderResource* In..., ESlateDrawPrimitive InPrimitiveType, ESlateShader InShaderType, ESlateDrawEffect InDrawEffects, ESlateBatchDrawFlag InDrawFlags, int8 InSceneIndex, FSlateVertexArray* InSourceVer..., FSlateIndexArray* InSourceInde..., int32 InVertexOffset, int32 InIndexOffset )

Functions

		Name	Description
	void	AddIndex ( SlateIndex Index )
	void	AddIndices ( const TArray< SlateIndex >& InIndi... )
	void	AddVertex ( FSlateVertex&& Vertex )
	void	AddVertices ( const TArray< FSlateVertex >& InVe... )
	const FSlate...	GetClippingState()
	ESlateDrawEf...	GetDrawEffects()
	ESlateBatchD...	GetDrawFlags()
	ESlateDrawPr...	GetDrawPrimitiveType()
	uint32	GetIndexOffset()
	int32	GetLayer()
	uint32	GetNumIndices()
	uint32	GetNumVertices()
	const FShade...	GetShaderParams()
	const FSlate...	GetShaderResource()
	ESlateShader	GetShaderType()
	uint32	GetVertexOffset()
	bool	HasVertexData()
	bool	IsBatchableWith ( const FSlateRenderBatch& Other )
	bool	IsValidForRendering()
	void	ReserveIndices ( uint32 Num )
	void	ReserveVertices ( uint32 Num )