FSlateRenderBatch Class Reference

#include <SlateRenderBatch.h>

Public Member Functions
	FSlateRenderBatch (int32 InLayer, const FShaderParams &InShaderParams, const FSlateShaderResource *InResource, ESlateDrawPrimitive InPrimitiveType, ESlateShader InShaderType, ESlateDrawEffect InDrawEffects, ESlateBatchDrawFlag InDrawFlags, int8 InSceneIndex, FSlateVertexArray *InSourceVertArray, FSlateIndexArray *InSourceIndexArray, int32 InVertexOffset, int32 InIndexOffset)
void	ReserveVertices (uint32 Num)
void	ReserveIndices (uint32 Num)
void	AddVertex (FSlateVertex &&Vertex)
void	AddIndex (SlateIndex Index)
void	EmplaceVertex (FSlateVertex &&Vertex)
void	EmplaceIndex (SlateIndex Index)
void	AddVertices (const TArray< FSlateVertex > &InVertices)
void	AddIndices (const TArray< SlateIndex > &InIndices)
void	AddVertices (TArray< FSlateVertex > &&InVertices)
void	AddIndices (TArray< SlateIndex > &&InIndices)
uint32	GetNumVertices () const
uint32	GetNumIndices () const
uint32	GetVertexOffset () const
uint32	GetIndexOffset () const
bool	HasVertexData () const
bool	IsBatchableWith (const FSlateRenderBatch &Other) const
int32	GetLayer () const
const FSlateClippingState *	GetClippingState () const
const FSlateShaderResource *	GetShaderResource () const
ESlateDrawPrimitive	GetDrawPrimitiveType () const
ESlateBatchDrawFlag	GetDrawFlags () const
ESlateDrawEffect	GetDrawEffects () const
ESlateShader	GetShaderType () const
const FShaderParams &	GetShaderParams () const
bool	IsValidForRendering () const

Public Attributes
FShaderParams	ShaderParams
FVector2f	DynamicOffset
const FSlateClippingState *	ClippingState
const FSlateShaderResource *	ShaderResource
ISlateUpdatableInstanceBufferRenderProxy *	InstanceData
FSlateVertexArray *	SourceVertices
FSlateIndexArray *	SourceIndices
ICustomSlateElement *	CustomDrawer
int32	LayerId
int32	VertexOffset
int32	IndexOffset
int32	NumVertices
int32	NumIndices
int32	NextBatchIndex
int32	InstanceCount
int32	InstanceOffset
ESlateBatchDrawFlag	DrawFlags
ESlateShader	ShaderType
ESlateDrawPrimitive	DrawPrimitiveType
ESlateDrawEffect	DrawEffects
ESlatePostRT	CachedUsedPostBuffers
int8	SceneIndex
uint8	bIsMergable: 1
uint8	bIsMerged: 1

Constructor & Destructor Documentation

FSlateRenderBatch()

FSlateRenderBatch::FSlateRenderBatch	(	int32	InLayer,
		const FShaderParams &	InShaderParams,
		const FSlateShaderResource *	InResource,
		ESlateDrawPrimitive	InPrimitiveType,
		ESlateShader	InShaderType,
		ESlateDrawEffect	InDrawEffects,
		ESlateBatchDrawFlag	InDrawFlags,
		int8	InSceneIndex,
		FSlateVertexArray *	InSourceVertArray,
		FSlateIndexArray *	InSourceIndexArray,
		int32	InVertexOffset,
		int32	InIndexOffset
	)

Member Function Documentation

AddIndex()

void FSlateRenderBatch::AddIndex ( SlateIndex  Index )

inline

AddIndices() [1/2]

void FSlateRenderBatch::AddIndices ( const TArray< SlateIndex > &  InIndices )

inline

AddIndices() [2/2]

void FSlateRenderBatch::AddIndices ( TArray< SlateIndex > &&  InIndices )

inline

AddVertex()

void FSlateRenderBatch::AddVertex ( FSlateVertex &&  Vertex )

inline

AddVertices() [1/2]

void FSlateRenderBatch::AddVertices ( const TArray< FSlateVertex > &  InVertices )

inline

AddVertices() [2/2]

void FSlateRenderBatch::AddVertices ( TArray< FSlateVertex > &&  InVertices )

inline

EmplaceIndex()

void FSlateRenderBatch::EmplaceIndex ( SlateIndex  Index )

inline

EmplaceVertex()

void FSlateRenderBatch::EmplaceVertex ( FSlateVertex &&  Vertex )

inline

GetClippingState()

const FSlateClippingState * FSlateRenderBatch::GetClippingState ( ) const

inline

GetDrawEffects()

ESlateDrawEffect FSlateRenderBatch::GetDrawEffects ( ) const

inline

GetDrawFlags()

ESlateBatchDrawFlag FSlateRenderBatch::GetDrawFlags ( ) const

inline

GetDrawPrimitiveType()

ESlateDrawPrimitive FSlateRenderBatch::GetDrawPrimitiveType ( ) const

inline

GetIndexOffset()

uint32 FSlateRenderBatch::GetIndexOffset ( ) const

inline

GetLayer()

int32 FSlateRenderBatch::GetLayer ( ) const

inline

GetNumIndices()

uint32 FSlateRenderBatch::GetNumIndices ( ) const

inline

GetNumVertices()

uint32 FSlateRenderBatch::GetNumVertices ( ) const

inline

GetShaderParams()

const FShaderParams & FSlateRenderBatch::GetShaderParams ( ) const

inline

GetShaderResource()

const FSlateShaderResource * FSlateRenderBatch::GetShaderResource ( ) const

inline

GetShaderType()

ESlateShader FSlateRenderBatch::GetShaderType ( ) const

inline

GetVertexOffset()

uint32 FSlateRenderBatch::GetVertexOffset ( ) const

inline

HasVertexData()

bool FSlateRenderBatch::HasVertexData ( ) const

inline

IsBatchableWith()

bool FSlateRenderBatch::IsBatchableWith ( const FSlateRenderBatch &  Other ) const

inline

IsValidForRendering()

bool FSlateRenderBatch::IsValidForRendering ( ) const

inline

ReserveIndices()

void FSlateRenderBatch::ReserveIndices ( uint32  Num )

inline

ReserveVertices()

void FSlateRenderBatch::ReserveVertices ( uint32  Num )

inline

Member Data Documentation

bIsMergable

uint8 FSlateRenderBatch::bIsMergable

Whether or not the batch can be merged with others in the same layer

bIsMerged

uint8 FSlateRenderBatch::bIsMerged

CachedUsedPostBuffers

ESlatePostRT FSlateRenderBatch::CachedUsedPostBuffers

ClippingState

const FSlateClippingState* FSlateRenderBatch::ClippingState

The Stored clipping state for the corresponding clipping state index. The indices are not directly comparable later, so we need to expand it to the full state to be compared.

CustomDrawer

ICustomSlateElement* FSlateRenderBatch::CustomDrawer

DrawEffects

ESlateDrawEffect FSlateRenderBatch::DrawEffects

DrawFlags

ESlateBatchDrawFlag FSlateRenderBatch::DrawFlags

DrawPrimitiveType

ESlateDrawPrimitive FSlateRenderBatch::DrawPrimitiveType

DynamicOffset

FVector2f FSlateRenderBatch::DynamicOffset

Dynamically modified offset that occurs when we have relative position stored render batches.

IndexOffset

int32 FSlateRenderBatch::IndexOffset

InstanceCount

int32 FSlateRenderBatch::InstanceCount

InstanceData

ISlateUpdatableInstanceBufferRenderProxy* FSlateRenderBatch::InstanceData

InstanceOffset

int32 FSlateRenderBatch::InstanceOffset

LayerId

int32 FSlateRenderBatch::LayerId

The layer we need to sort by

NextBatchIndex

int32 FSlateRenderBatch::NextBatchIndex

NumIndices

int32 FSlateRenderBatch::NumIndices

Number of indices in the batch

NumVertices

int32 FSlateRenderBatch::NumVertices

Number of vertices in the batch

SceneIndex

int8 FSlateRenderBatch::SceneIndex

ShaderParams

FShaderParams FSlateRenderBatch::ShaderParams

ShaderResource

const FSlateShaderResource* FSlateRenderBatch::ShaderResource

Shader Resource to use with this batch.

ShaderType

ESlateShader FSlateRenderBatch::ShaderType

SourceIndices

FSlateIndexArray* FSlateRenderBatch::SourceIndices

SourceVertices

FSlateVertexArray* FSlateRenderBatch::SourceVertices

VertexOffset

int32 FSlateRenderBatch::VertexOffset

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/SlateCore/Public/Rendering/SlateRenderBatch.h
• Engine/Source/Runtime/SlateCore/Private/Rendering/SlateRenderBatch.cpp