1. Epic GamesDeveloper
  3. FRDGPass

FRDGPass

Base class of a render graph pass.

API > API/Runtime > API/Runtime/RenderCore

Inheritance Hierarchy

References

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

Syntax

class FRDGPass

Remarks

Base class of a render graph pass.

Variables

  Type Name Description
Protected variable union FRDGPass::@2982 @2983  
Protected variable union FRDGPass::@2984 @2985  
Protected variable EAsyncComputeBudget AsyncComputeBudget  
Public variable uint32: 1 bAsyncComputeBegin (AsyncCompute only) Whether this is the first / last async compute pass in an async interval.
Public variable uint32: 1 bAsyncComputeEnd  
Public variable uint32: 1 bCulled Whether this pass has been culled.
Public variable uint32: 1 bDispatchAfterExecute If set, dispatches to the RHI thread after executing this pass.
Public variable uint32: 1 bEmptyParameters Whether this pass does not contain parameters.
Public variable uint32: 1 bExternalAccessPass Whether this pass is used for external access transitions.
Public variable uint32: 1 bGraphicsFork (Graphics only) Whether this is a graphics fork / join pass.
Public variable uint32: 1 bGraphicsJoin  
Public variable uint32: 1 bHasExternalOutputs Whether this pass has external UAVs that are not tracked by RDG.
Public variable uint32: 1 bParallelExecute If set, marks that a pass is executing in parallel.
Public variable uint32: 1 bParallelExecuteAllowed Whether the pass is allowed to execute in parallel.
Public variable uint32: 1 bParallelExecuteBegin If set, marks the begin / end of a span of passes executed in parallel in a task.
Public variable uint32: 1 bParallelExecuteEnd  
Public variable uint32: 1 bRenderPassOnlyWrites Whether the pass only writes to resources in its render pass.
Public variable uint32: 1 bSentinel Whether this pass is a sentinel (prologue / epilogue) pass.
Public variable uint32: 1 bSetCommandListStat If set, the pass should set its command list stat.
Public variable uint32: 1 bSkipRenderPassBegin Whether the render pass begin / end should be skipped.
Public variable uint32: 1 bSkipRenderPassEnd  
Protected variable TArray< FBufferState, FRDGArrayAllocator > BufferStates  
Protected variable FRDGPassHandleArray CrossPipelineConsumers Lists of producer passes and the full list of cross-pipeline consumer passes.
Protected variable FRDGPassHandle CrossPipelineProducer Handle of the latest cross-pipeline producer.
Protected variable FRDGPassHandle EpilogueBarrierPass  
Protected variable FRDGBarrierBatchBegin * EpilogueBarriersToBeginForAll  
Protected variable FRDGBarrierBatchBegin * EpilogueBarriersToBeginForAsyncCompute  
Protected variable FRDGBarrierBatchBegin EpilogueBarriersToBeginForGraphics  
Protected variable FRDGBarrierBatchEnd * EpilogueBarriersToEnd  
Protected variable TArray< FExternalAccessOp, FRDGArrayAllocator > ExternalAccessOps  
Protected variable const ERDGPassFlags Flags  
Protected variable friend FRDGBuilder  
Protected variable friend FRDGPassRegistry  
Protected variable friend FRDGTrace  
Protected variable friend FRDGUserValidation  
Protected variable FString FullPathIfDebug When r.RDG.Debug is enabled, this will include a full namespace path with event scopes included.
Protected variable FRDGGPUScopeOpArrays GPUScopeOpsEpilogue  
Protected variable FRDGGPUScopeOpArrays GPUScopeOpsPrologue  
Protected variable FRDGGPUScopes GPUScopes  
Protected variable FRDGPassHandle GraphicsForkPass (AsyncCompute only) Graphics passes which are the fork / join for async compute interval this pass is in.
Protected variable FRDGPassHandle GraphicsJoinPass  
Protected variable FRDGPassHandle Handle  
Protected variable const FRDGEventName Name  
Public variable uint32 PackedBits1  
Public variable uint32 PacketBits2  
Protected variable uint16 ParallelPassSetIndex  
Protected variable const FRDGParameterStruct ParameterStruct  
Protected variable const ERHIPipeline Pipeline  
Protected variable FRDGPassHandleArray Producers  
Protected variable FRDGPassHandle PrologueBarrierPass The passes which are handling the epilogue / prologue barriers meant for this pass.
Protected variable FRDGBarrierBatchBegin * PrologueBarriersToBegin Split-barrier batches at various points of execution of the pass.
Protected variable FRDGBarrierBatchEnd PrologueBarriersToEnd  
Protected variable TArray< FRDGPass *, TInlineAllocator< 1, FRDGArrayAllocator > > ResourcesToBegin Lists of pass parameters scheduled for begin during execution of this pass.
Protected variable TArray< FRDGPass *, TInlineAllocator< 1, FRDGArrayAllocator > > ResourcesToEnd  
Protected variable TArray< FRDGBarrierBatchBegin *, FRDGArrayAllocator > SharedEpilogueBarriersToBegin  
Protected variable TArray< FTextureState, FRDGArrayAllocator > TextureStates Maps textures / buffers to information on how they are used in the pass.
Protected variable TArray< FRDGUniformBufferHandle, FRDGArrayAllocator > UniformBuffers  
Protected variable TArray< FRDGViewHandle, FRDGArrayAllocator > Views  
Protected variable uint32 Workload  

Constructors

  Type Name Description
Public function  

FRDGPass ( const FRDGPass&
)

  
Public function  

FRDGPass ( FRDGEventName&& InName,
FRDGParameterStruct InParameterStruct,
ERDGPassFlags InFlags
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function Virtual void  
Protected function FRDGBarrierBatchBegin &

GetEpilogueBarriersToBeginFor ( FRDGAllocator& Allocator,
FRDGTransitionCreateQueue& CreateQueue,
ERHIPipeline PipelineForEnd
)

  
Protected function FRDGBarrierBatchBegin &

GetEpilogueBarriersToBeginForAll ( FRDGAllocator& Allocator,
FRDGTransitionCreateQueue& CreateQueue
)

  
Protected function FRDGBarrierBatchBegin &

GetEpilogueBarriersToBeginForAsyncCompute ( FRDGAllocator& Allocator,
FRDGTransitionCreateQueue& CreateQueue
)

  
Protected function FRDGBarrierBatchBegin &

GetEpilogueBarriersToBeginForGraphics ( FRDGAllocator& Allocator,
FRDGTransitionCreateQueue& CreateQueue
)

  
Protected function FRDGBarrierBatchEnd &  
Public function Const const FRDGEventName &  
Public function Const ERDGPassFlags  
Public function Const FRDGGPUScopes  
Public function Const FRDGPassHandle Returns the graphics pass responsible for forking the async interval this pass is in.
Public function Const FRDGPassHandle Returns the graphics pass responsible for joining the async interval this pass is in.
Public function Const FRDGPassHandle  
Public function Const const TCHAR *

GetName ()

  
Public function Const FRDGParameterStruct  
Public function Const ERHIPipeline  
Public function Const const FRDGPassHandleArray &  
Protected function FRDGBarrierBatchBegin &

GetPrologueBarriersToBegin ( FRDGAllocator& Allocator,
FRDGTransitionCreateQueue& CreateQueue
)

  
Protected function FRDGBarrierBatchEnd &  
Public function Const uint32  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  

Classes

  Type Name Description
Protected struct FBufferState    
Protected struct FExternalAccessOp    
Protected struct FTextureState    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page