Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Runtime > Engine > FMeshElementCollector

Light Theme

Dark Theme

FMeshElementCollector

Encapsulates the gathering of meshes from the various [FPrimitiveSceneProxy](API\Runtime\Engine\FPrimitiveSceneProxy) classes.

Choose your operating system:

Windows

macOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/SceneManagement.h
Include	#include "SceneManagement.h"

Syntax

class FMeshElementCollector

Remarks

Encapsulates the gathering of meshes from the various FPrimitiveSceneProxy classes.

Variables

		Name	Description
	const bool	bUseAsyncTasks	This is related to some cvars and FApp stuff and if true means calling code should use async tasks.
	FGlobalDynamicI...	DynamicIndexBuffer	Dynamic buffer pools.
	TArray< FGPUSce...	DynamicPrimitiveCollectorPerView	Tracks dynamic primitive data for upload to GPU Scene for every view, when enabled.
	FGlobalDynamicR...	DynamicReadBuffer
	FGlobalDynamicV...	DynamicVertexBuffer
	ERHIFeatureLeve...	FeatureLevel
	TArray< TArray<...	MeshBatches	Meshes to render
	TChunkedArray< ...	MeshBatchStorage	Using TChunkedArray which will never realloc as new elements are added
	TArray< uint16,...	MeshIdInPrimitivePerView	Current Mesh Id In Primitive per view
	TArray< int32, ...	NumMeshBatchElementsPerView	Number of elements in gathered meshes per view.
	TArray< FOneFra...	OneFrameResources	Resources that will be deleted at the end of the frame.
	TArray< TFuncti...	ParallelTasks	Tasks to wait for at the end of gathering dynamic mesh elements.
	const FPrimitiv...	PrimitiveSceneProxy	Current primitive being gathered.
	TArray< FSimple...	SimpleElementCollectors	PDIs
	TArray< FMateri...	TemporaryProxies	Material proxies that will be deleted at the end of the frame.
	TArray< FSceneV...	Views	Views being collected for

Constructors

	Name	Description
	FMeshElementCollector ( ERHIFeatureLevel::Type InFeatureLev... )

Destructors

	Name	Description
	~FMeshElementCollector()

Functions

		Name	Description
	void	AddMesh ( int32 ViewIndex, FMeshBatch& MeshBatch )	Adds a mesh batch to the collector for the specified view so that it can be rendered.
	void	AddTask ( TFunction< void()>&& Task )
	void	AddTask ( const TFunction< void()>& Task )
	void	AddViewMeshArrays ( FSceneView* InView, TArray< FMeshBatchAndRelevance, Sce..., FSimpleElementCollector* ViewS..., FGPUScenePrimitiveCollector* I..., ERHIFeatureLevel::Type InFeatureLev..., FGlobalDynamicIndexBuffer* InD..., FGlobalDynamicVertexBuffer* In..., FGlobalDynamicReadBuffer* InDy... )
	FMeshBatch &	AllocateMesh()	Allocates an FMeshBatch that can be safely referenced by the collector (lifetime will be long enough).
	T &	AllocateOneFrameResource ( ARGS&&... Args )	Allocates a temporary resource that is safe to be referenced by an FMeshBatch added to the collector.
	void	ClearViewMeshArrays()
	FGlobalDynam...	GetDynamicIndexBuffer()	Return dynamic index buffer for this collector.
	FGlobalDynam...	GetDynamicReadBuffer()	Return dynamic read buffer for this collector.
	FGlobalDynam...	GetDynamicVertexBuffer()	Return dynamic vertex buffer for this collector.
	ERHIFeatureL...	GetFeatureLevel()
	uint32	GetMeshBatchCount ( uint32 ViewIndex )
	uint32	GetMeshElementCount ( uint32 ViewIndex )
	FPrimitiveDr...	GetPDI ( int32 ViewIndex )	Accesses the PDI for drawing lines, sprites, etc.
	void	ProcessTasks()
	void	RegisterOneFrameMaterialProxy ( FMaterialRenderProxy* Proxy )	Add a material render proxy that will be cleaned up automatically
	void	SetPrimitive ( const FPrimitiveSceneProxy* In..., FHitProxyId DefaultHitProxyId )
	bool	ShouldUseTasks()