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 > Renderer > FMeshDrawCommand

Light Theme

Dark Theme

FMeshDrawCommand

[FMeshDrawCommand](API\Runtime\Renderer\FMeshDrawCommand) fully describes a mesh pass draw call, captured just above the RHI.

Windows

MacOS

Linux

References

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

Syntax

class FMeshDrawCommand

Remarks

FMeshDrawCommand fully describes a mesh pass draw call, captured just above the RHI. FMeshDrawCommand should contain only data needed to draw. For InitViews payloads, use FVisibleMeshDrawCommand. FMeshDrawCommands are cached at Primitive AddToScene time for vertex factories that support it (no per-frame or per-view shader binding changes). Dynamic Instancing operates at the FMeshDrawCommand level for robustness. Adding per-command shader bindings will reduce the efficiency of Dynamic Instancing, but rendering will always be correct. Any resources referenced by a command must be kept alive for the lifetime of the command. FMeshDrawCommand is not responsible for lifetime management of resources. For uniform buffers referenced by cached FMeshDrawCommand's, RHIUpdateUniformBuffer makes it possible to access per-frame data in the shader without changing bindings.

Variables

	Name	Description
union FMeshDraw...	@3657
uint32	BaseVertexIndex
FRHIVertexBuffe...	Buffer
FGraphicsMinima...	CachedPipelineId	PSO
uint32	FirstIndex	Draw command parameters
FRHIIndexBuffer...	IndexBuffer
FMeshDrawComman...	IndirectArgs
uint32	NumInstances
uint32	NumPrimitives
uint32	NumVertices
uint32	Offset
int8	PrimitiveIdStreamIndex
FMeshDrawShader...	ShaderBindings	Resource bindings
uint8	StencilRef	Non-pipeline state
FMeshDrawComman...	VertexParams
FVertexInputStr...	VertexStreams

Constructors

	Name	Description
	FMeshDrawCommand()
	FMeshDrawCommand ( FMeshDrawCommand&& Other )
	FMeshDrawCommand ( const FMeshDrawCommand& Other )

Functions

	Name	Description
void	ClearDebugPrimitiveSceneProxy()
void	Finalize ( FGraphicsMinimalPipelineStateId Pip..., const FMeshProcessorShaders* S... )
SIZE_T	GetAllocatedSize()
SIZE_T	GetDebugDataSize()
uint32	GetDynamicInstancingHash()
bool	MatchesForDynamicInstancing ( const FMeshDrawCommand& Rhs )
void	SetDebugData ( const FPrimitiveSceneProxy* Pr..., const FMaterial* Material, const FMaterialRenderProxy* Ma..., const FMeshProcessorShaders& Untyp..., const FVertexFactory* VertexFa... )
void	SetDrawParametersAndFinalize ( const FMeshBatch& MeshBatch, int32 BatchElementIndex, FGraphicsMinimalPipelineStateId Pip..., const FMeshProcessorShaders* S... )	Called when the mesh draw command is complete.
void	SetShaders ( FRHIVertexDeclaration* VertexD..., const FMeshProcessorShaders& Shade..., FGraphicsMinimalPipelineStateInitia... )	Sets shaders on the mesh draw command and allocates room for the shader bindings.
void	SetStencilRef ( uint32 InStencilRef )
void	SubmitDraw ( const FMeshDrawCommand&restrict ..., const FGraphicsMinimalPipelineState..., FRHIVertexBuffer* ScenePrimiti..., int32 PrimitiveIdOffset, uint32 InstanceFactor, FRHICommandList& CommandList, FMeshDrawCommandStateCache&restr... )	Submits commands to the RHI Commandlist to draw the MeshDrawCommand.

Operators

		Name	Description
	FMeshDrawCom...	operator= ( const FMeshDrawCommand& Other )
	FMeshDrawCom...	operator= ( FMeshDrawCommand&& Other )

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

Take our survey

Dismiss