1. Epic GamesDeveloper
  3. FInstanceCullingContext

FInstanceCullingContext

API > API/Runtime > API/Runtime/Renderer > API/Runtime/Renderer/InstanceCulling

References

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

Syntax

class FInstanceCullingContext

Variables

  Type Name Description
Public variable bool bIsEnabled  
Public variable TArray< uint32, SceneRenderingAllocator > CompactionBlockDataIndices  
Public variable TArray< FCompactionData, SceneRenderingAllocator > DrawCommandCompactionData  
Public variable TArray< uint32, SceneRenderingAllocator > DrawCommandDescs  
Public variable int32 DynamicInstanceIdNum  
Public variable int32 DynamicInstanceIdOffset  
Public variable ERHIFeatureLevel::Type FeatureLevel  
Public variable EInstanceCullingFlags Flags  
Public variable TArray< FRHIDrawIndexedIndirectParameters, SceneRenderingAllocator > IndirectArgs  
Public variable FInstanceCullingManager * InstanceCullingManager  
Public variable EInstanceCullingMode InstanceCullingMode  
Public variable TArray< uint32, SceneRenderingAllocator > InstanceIdOffsets  
Public variable LoadBalancerArray LoadBalancers Driver for collecting items using one mode of processing.
Public variable TArray< FMeshDrawCommandInfo, SceneRenderingAllocator > MeshDrawCommandInfos  
Public variable uint32 NumCompactionInstances  
Public variable TArray< FPayloadData, SceneRenderingAllocator > PayloadData  
Public variable TRefCountPtr< IPooledRenderTarget > PrevHZB  
Public variable EBatchProcessingMode SingleInstanceProcessingMode Processing mode to use for single-instance primitives, default to skip culling, as this is already done on CPU.
Public variable SyncPrerequisitesFuncType SyncPrerequisitesFunc  
Public variable uint32 TotalInstances  
Public variable TArray< int32, TInlineAllocator< 6, SceneRenderingAllocator > > ViewIds  

Constructors

  Type Name Description
Public function    
Public function  

FInstanceCullingContext ( ERHIFeatureLevel::Type FeatureLevel,
FInstanceCullingManager* InInstanceCullingManager,
TArrayView< const int32 > InViewIds,
const TRefCountPtr< IPooledRenderTarget >& InPrevHZB,
EInstanceCullingMode InInstanceCullingMode,
EInstanceCullingFlags InFlags,
EBatchProcessingMode InSingleInstanceProcessingMode
)

 Create an instance culling context to process draw commands that can be culled using GPU-Scene.

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static void

AddClearIndirectArgInstanceCountPass ( FRDGBuilder& GraphBuilder,
FGlobalShaderMap* ShaderMap,
FRDGBufferRef DrawIndirectArgsBuffer,
TFunction< int32()> NumIndirectArgsCallback
)

 Helper function to add a pass to zero the instance count in the indirect args.
Public function void

AddInstanceRunsToDrawCommand ( uint32 IndirectArgsOffset,
int32 InstanceDataOffset,
const uint32* Runs,
uint32 NumRuns,
EInstanceFlags InstanceFlags
)

 Command that is executed in the per-view, post-cull pass to gather up the instances belonging to this primitive.
Public function void

AddInstancesToDrawCommand ( uint32 IndirectArgsOffset,
int32 InstanceDataOffset,
uint32 RunOffset,
uint32 NumInstances,
EInstanceFlags InstanceFlags
)

 Add command to cull a range of instances for the given mesh draw command index.
Public function uint32

AllocateIndirectArgs ( const FMeshDrawCommand* MeshDrawCommand
)

 Allocate space for indirect draw call argumens for a given MeshDrawCommand and initialize with draw command data.
Public function void

BeginAsyncSetup ( SyncPrerequisitesFuncType&& InSyncPrerequisitesFunc
)

 Set up the context to track an async setup process, or some deferred setup work.
Public function void

BuildRenderingCommands ( FRDGBuilder& GraphBuilder,
const FGPUScene& GPUScene,
int32 InDynamicInstanceIdOffset,
int32 InDynamicInstanceIdNum,
FInstanceCullingResult& Results
)

 This version is never deferred, nor async, calling BeginAsyncSetup before this is an error.
Public function void

BuildRenderingCommands ( FRDGBuilder& GraphBuilder,
const FGPUScene& GPUScene,
FInstanceCullingDrawParams* InstanceCullingDrawParams
)

 This BuildRenderingCommands operation may be deferred and merged into a global pass when possible.
Public function void

BuildRenderingCommandsInternal ( FRDGBuilder& GraphBuilder,
const FGPUScene& GPUScene,
EAsyncProcessingMode AsyncProcessingMode,
FInstanceCullingDrawParams* InstanceCullingDrawParams
)

  
Public function Static FInstanceCullingDeferredContext *

CreateDeferredContext ( FRDGBuilder& GraphBuilder,
FGPUScene& GPUScene,
FInstanceCullingManager* InstanceCullingManager
)

 Add a batched BuildRenderingCommands pass.
Public function Static const TRDGUniformBufferRef< FInstanceCullingGlobalUniforms >  
Public function Const EInstanceCullingMode  
Public function Static uint32  
Public function Const bool Returns true if there are any instances in this context needing to be rendered.
Public function Const bool  
Public function Const bool  
Public function Static bool  
Public function void

ResetCommands ( int32 MaxNumCommands
)

 Call to empty out the culling commands & other culling data.
Public function void

SetDynamicPrimitiveInstanceOffsets ( int32 InDynamicInstanceIdOffset,
int32 InDynamicInstanceIdNum
)

  
Public function void

SetupDrawCommands ( FMeshCommandOneFrameArray& VisibleMeshDrawCommandsInOut,
bool bCompactIdenticalCommands,
int32& MaxInstancesOut,
int32& VisibleMeshDrawCommandsNumOut,
int32& NewPassVisibleMeshDrawCommandsNumOut
)

  
Public function void

SetupDrawCommands ( TArrayView< const FStateBucketAuxData > StateBucketsAuxData,
FMeshCommandOneFrameArray& VisibleMeshDrawCommandsInOut,
bool bCompactIdenticalCommands,
int32& MaxInstancesOut,
int32& VisibleMeshDrawCommandsNumOut,
int32& NewPassVisibleMeshDrawCommandsNumOut
)

 Allocate indirect arg slots for all meshes to use instancing, add commands that populate the indirect calls and index & id buffers, and Collapse all commands that share the same state bucket ID NOTE: VisibleMeshDrawCommandsInOut can only become shorter.
Public function Static uint32

StepInstanceDataOffset ( ERHIFeatureLevel::Type FeatureLevel,
uint32 NumStepInstances,
uint32 NumStepDraws
)

  
Public function Const void

SubmitDrawCommands ( const FMeshCommandOneFrameArray& VisibleMeshDrawCommands,
const FGraphicsMinimalPipelineStateSet& GraphicsMinimalPipelineStateSet,
const FMeshDrawCommandOverrideArgs& OverrideArgs,
int32 StartIndex,
int32 NumMeshDrawCommands,
uint32 InstanceFactor,
FRHICommandList& RHICmdList
)

  
Public function void Calls the sync function passed tp BeginAsyncSetup to ensure the setup processing is completed.

Classes

  Type Name Description
Public struct FCompactionData    
Public struct FMeshDrawCommandInfo Auxiliary info for each mesh draw command that needs submitting.  
Public struct FPayloadData    

Enums

  Type Name Description
Public enum EAsyncProcessingMode    
Public enum EInstanceFlags    

Typedefs

Name Description
LoadBalancerArray  
SyncPrerequisitesFuncType  

Constants

Name Description
CompactionBlockNumInstances  
IndirectArgsNumWords  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page