Navigation
API > API/Runtime > API/Runtime/RenderCore
Base class of a render graph pass.
| Name | FRDGPass |
| Type | class |
| Header File | /Engine/Source/Runtime/RenderCore/Public/RenderGraphPass.h |
| Include Path | #include "RenderGraphPass.h" |
Syntax
class FRDGPass
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| RenderGraphPass.h | |||
FRDGPass
(
FRDGEventName&& InName, |
RenderGraphPass.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FRDGPass() |
RenderGraphPass.h |
Structs
| Name | Remarks |
|---|---|
| FBufferState | |
| FExternalAccessOp | |
| FTextureState |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAsyncComputeBegin | uint16 | (AsyncCompute only) Whether this is the first / last async compute pass in an async interval. | RenderGraphPass.h | |
| bAsyncComputeEnd | uint16 | RenderGraphPass.h | ||
| bCulled | uint8 | Whether this pass has been culled. | RenderGraphPass.h | |
| bDispatchAfterExecute | uint16 | If set, dispatches to the RHI thread after executing this pass. | RenderGraphPass.h | |
| bDispatchPass | uint16 | If set, this is a dispatch pass. | RenderGraphPass.h | |
| bEmptyParameters | uint8 | Whether this pass does not contain parameters. | RenderGraphPass.h | |
| bExternalAccessPass | uint8 | Whether this pass is used for external access transitions. | RenderGraphPass.h | |
| bGraphicsFork | uint16 | (Graphics only) Whether this is a graphics fork / join pass. | RenderGraphPass.h | |
| bGraphicsJoin | uint16 | RenderGraphPass.h | ||
| bHasExternalOutputs | uint8 | Whether this pass has external UAVs that are not tracked by RDG. | RenderGraphPass.h | |
| bParallelExecute | uint8 | If set, marks that a pass is executing in parallel. | RenderGraphPass.h | |
| bParallelExecuteBegin | uint8 | If set, marks the begin / end of a span of passes executed in parallel in a task. | RenderGraphPass.h | |
| bParallelExecuteEnd | uint8 | RenderGraphPass.h | ||
| bRenderPassOnlyWrites | uint16 | Whether the pass only writes to resources in its render pass. | RenderGraphPass.h | |
| bSentinel | uint16 | Whether this pass is a sentinel (prologue / epilogue) pass. | RenderGraphPass.h | |
| bSkipRenderPassBegin | uint16 | Whether the render pass begin / end should be skipped. | RenderGraphPass.h | |
| bSkipRenderPassEnd | uint16 | RenderGraphPass.h | ||
| PackedBits | uint16 | RenderGraphPass.h | ||
| PacketBits_AsyncSetupQueue | uint8 | RenderGraphPass.h | ||
| PacketBits_ParallelExecute | uint8 | RenderGraphPass.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FRDGEventName & GetEventName() |
RenderGraphPass.h | ||
ERDGPassFlags GetFlags() |
RenderGraphPass.h | ||
FRHIGPUMask GetGPUMask() |
RenderGraphPass.h | ||
FRDGPassHandle GetGraphicsForkPass() |
Returns the graphics pass responsible for forking the async interval this pass is in. | RenderGraphPass.h | |
FRDGPassHandle GetGraphicsJoinPass() |
Returns the graphics pass responsible for joining the async interval this pass is in. | RenderGraphPass.h | |
FRDGPassHandle GetHandle() |
RenderGraphPass.h | ||
const TCHAR * GetName() |
RenderGraphPass.h | ||
FRDGParameterStruct GetParameters() |
RenderGraphPass.h | ||
ERHIPipeline GetPipeline() |
RenderGraphPass.h | ||
FRDGScope const * GetScope() |
RenderGraphPass.h | ||
ERDGPassTaskMode GetTaskMode() |
RenderGraphPass.h | ||
uint32 GetWorkload() |
RenderGraphPass.h | ||
bool IsAsyncCompute() |
RenderGraphPass.h | ||
bool IsAsyncComputeBegin() |
RenderGraphPass.h | ||
bool IsAsyncComputeEnd() |
RenderGraphPass.h | ||
bool IsCulled() |
RenderGraphPass.h | ||
bool IsGraphicsFork() |
RenderGraphPass.h | ||
bool IsGraphicsJoin() |
RenderGraphPass.h | ||
bool IsMergedRenderPassBegin() |
RenderGraphPass.h | ||
bool IsMergedRenderPassEnd() |
RenderGraphPass.h | ||
bool IsParallelExecuteAllowed() |
RenderGraphPass.h | ||
bool IsSentinel() |
RenderGraphPass.h | ||
bool SkipRenderPassBegin() |
RenderGraphPass.h | ||
bool SkipRenderPassEnd() |
RenderGraphPass.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute
(
FRHIComputeCommandList& RHICmdList |
RenderGraphPass.h | ||
FRDGBarrierBatchBegin & GetEpilogueBarriersToBeginFor
(
FRDGAllocator& Allocator, |
RenderGraphPass.h | ||
FRDGBarrierBatchBegin & GetEpilogueBarriersToBeginForAll
(
FRDGAllocator& Allocator, |
RenderGraphPass.h | ||
FRDGBarrierBatchBegin & GetEpilogueBarriersToBeginForAsyncCompute
(
FRDGAllocator& Allocator, |
RenderGraphPass.h | ||
FRDGBarrierBatchBegin & GetEpilogueBarriersToBeginForGraphics
(
FRDGAllocator& Allocator, |
RenderGraphPass.h | ||
FRDGBarrierBatchEnd & GetEpilogueBarriersToEnd
(
FRDGAllocator& Allocator |
RenderGraphPass.h | ||
FRDGBarrierBatchBegin & GetPrologueBarriersToBegin
(
FRDGAllocator& Allocator, |
RenderGraphPass.h | ||
FRDGBarrierBatchEnd & GetPrologueBarriersToEnd
(
FRDGAllocator& Allocator |
RenderGraphPass.h | ||
virtual void LaunchDispatchPassTasks
(
FRDGDispatchPassBuilder& DispatchPassBuilder |
RenderGraphPass.h |