Navigation
API > API/Runtime > API/Runtime/RenderCore
Main RDG scope class.
A tree of these scopes is created by the render thread as the RenderGraph is built. Each scope type implementation uses the following functions, which are called during different RDG phases:
Constructor / ImmediateEnd() - Render thread timeline. Called once, either side of scoped graph building work.
BeginCPU / EndCPU - Parallel threads. Called during RDG pass lambdas execution. Scopes may be entered / exited multiple times depending on parallel pass set bucketing.
BeginGPU / EndGPU - Parallel threads. Called once for each GPU pipeline the scope covers. Used for inserting commands on the RHICmdList. The command list passed to Begin / End may be different in each, depending on parallel pass set bucketing.
| Name | FRDGScope |
| Type | struct |
| Header File | /Engine/Source/Runtime/RenderCore/Public/RenderGraphEvent.h |
| Include Path | #include "RenderGraphEvent.h" |
Syntax
struct FRDGScope
Inheritance Hierarchy
- TRDGEventScopeGuard → FRDGScope
- FRDGScope
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRDGScope
(
FRDGScope* Parent |
RenderGraphEvent.h |
Classes
| Name | Remarks |
|---|---|
| TStorage |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FStorage | TStorage< FRDGScope_Budget, FRDGScope_RHI > | RenderGraphEvent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CPUFirstPass | FRDGPass * | RenderGraphEvent.h | ||
| CPULastPass | FRDGPass * | RenderGraphEvent.h | ||
| GPUFirstPass | TRHIPipelineArray< FRDGPass * > | RenderGraphEvent.h | ||
| GPULastPass | TRHIPipelineArray< FRDGPass * > | RenderGraphEvent.h | ||
| Impl | FStorage | RenderGraphEvent.h | ||
| Parent | FRDGScope *const | RenderGraphEvent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BeginCPU
(
FRHIComputeCommandList& RHICmdList, |
RenderGraphEvent.h | ||
void BeginGPU
(
FRHIComputeCommandList& RHICmdList |
RenderGraphEvent.h | ||
void EndCPU
(
FRHIComputeCommandList& RHICmdList, |
RenderGraphEvent.h | ||
void EndGPU
(
FRHIComputeCommandList& RHICmdList |
RenderGraphEvent.h | ||
TScopeType * Get () |
RenderGraphEvent.h | ||
TScopeType const * Get () |
RenderGraphEvent.h | ||
FString GetFullPath
(
FRDGEventName const& PassName |
RenderGraphEvent.h | ||
void ImmediateEnd
(
FRDGScopeState& State |
RenderGraphEvent.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static uint32 GetTypeMask() |
RenderGraphEvent.h |