1. Epic GamesDeveloper
  3. FMeshDrawCommand

FMeshDrawCommand

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

API > API/Runtime > API/Runtime/Renderer

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

  Type Name Description
Public variable union FMeshDrawCommand::@6086 @6087  
Public variable uint32 BaseVertexIndex  
Public variable FRHIBuffer * Buffer  
Public variable FGraphicsMinimalPipelineStateId CachedPipelineId PSO
Public variable uint32 FirstIndex Draw command parameters
Public variable FRHIBuffer * IndexBuffer  
Public variable FMeshDrawCommand::@6086::@6089 IndirectArgs  
Public variable uint32 NumInstances  
Public variable uint32 NumPrimitives  
Public variable uint32 NumVertices  
Public variable uint32 Offset  
Public variable int8 PrimitiveIdStreamIndex  
Public variable EPrimitiveType: PT_NumBits PrimitiveType Redundant as already present in CachedPipelineId, but need access for dynamic instancing on GPU.
Public variable FMeshDrawShaderBindings ShaderBindings Resource bindings
Public variable uint8 StencilRef Non-pipeline state
Public variable FMeshDrawCommand::@6086::@6088 VertexParams  
Public variable FVertexInputStreamArray VertexStreams  

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Functions

  Type Name Description
Public function Const void  
Public function void

Finalize ( FGraphicsMinimalPipelineStateId PipelineId,
const FMeshProcessorShaders* ShadersForDebugging
)

  
Public function Const SIZE_T  
Public function Const SIZE_T  
Public function Const uint32  
Public function Const uint64 Returns the pipeline state sort key, which can be used for sorting material draws to reduce context switches.
Public function Const uint64 Returns the pipeline state sort key, which can be used for sorting material draws to reduce context switches.
Public function void Allocates room for the shader bindings.
Public function Const bool  
Public function void

SetDebugData ( const FPrimitiveSceneProxy* PrimitiveSceneProxy,
const FMaterial* Material,
const FMaterialRenderProxy* MaterialRenderProxy,
const FMeshProcessorShaders& UntypedShaders,
const FVertexFactory* VertexFactory,
uint32 MeshPassType
)

  
Public function void

SetDrawParametersAndFinalize ( const FMeshBatch& MeshBatch,
int32 BatchElementIndex,
FGraphicsMinimalPipelineStateId PipelineId,
const FMeshProcessorShaders* ShadersForDebugging
)

 Called when the mesh draw command is complete.
Public function void

SetStencilRef ( uint32 InStencilRef
)

  
Public function Static void

SubmitDraw ( const FMeshDrawCommand&__restrict MeshDrawCommand,
const FGraphicsMinimalPipelineStateSet& GraphicsMinimalPipelineStateSet,
FRHIBuffer* ScenePrimitiveIdsBuffer,
int32 PrimitiveIdOffset,
uint32 InstanceFactor,
FRHICommandList& CommandList,
FMeshDrawCommandStateCache&__restrict StateCache,
FRHIBuffer* IndirectArgsOverrideBuffer,
uint32 IndirectArgsOverrideByteOffset
)

 Submits commands to the RHI Commandlist to draw the MeshDrawCommand.
Public function Static bool

SubmitDrawBegin ( const FMeshDrawCommand&__restrict MeshDrawCommand,
const FGraphicsMinimalPipelineStateSet& GraphicsMinimalPipelineStateSet,
FRHIBuffer* ScenePrimitiveIdsBuffer,
int32 PrimitiveIdOffset,
uint32 InstanceFactor,
FRHICommandList& RHICmdList,
FMeshDrawCommandStateCache&__restrict StateCache,
bool bAllowSkipDrawCommand
)

 Submits the state and shader bindings to the RHI command list, but does not invoke the draw.
Public function Static void

SubmitDrawEnd ( const FMeshDrawCommand& MeshDrawCommand,
uint32 InstanceFactor,
FRHICommandList& RHICmdList,
FRHIBuffer* IndirectArgsOverrideBuffer,
uint32 IndirectArgsOverrideByteOffset
)

 Submits just the draw primitive portion of the draw command.
Public function Static bool

SubmitDrawIndirectBegin ( const FMeshDrawCommand&__restrict MeshDrawCommand,
const FGraphicsMinimalPipelineStateSet& GraphicsMinimalPipelineStateSet,
FRHIBuffer* ScenePrimitiveIdsBuffer,
int32 PrimitiveIdOffset,
uint32 InstanceFactor,
FRHICommandList& RHICmdList,
FMeshDrawCommandStateCache&__restrict StateCache,
bool bAllowSkipDrawCommand
)

 Submits the state and shader bindings to the RHI command list, but does not invoke the draw indirect.
Public function Static void

SubmitDrawIndirectEnd ( const FMeshDrawCommand& MeshDrawCommand,
uint32 InstanceFactor,
FRHICommandList& RHICmdList,
FRHIBuffer* IndirectArgsOverrideBuffer,
uint32 IndirectArgsOverrideByteOffset
)

 Submits just the draw indirect primitive portion of the draw command.

Operators

  Type Name Description
Public function FMeshDrawCommand &  
Public function FMeshDrawCommand &

operator= ( const FMeshDrawCommand& Other
)

  

Classes

  Type Name Description
Public struct FMeshDrawEvent    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page