UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
RenderGraphEvent.h File Reference

Go to the source code of this file.

Classes

class  FRDGEventName
 
struct  FRDGScope_Budget
 
struct  FRDGScope
 
class  FRDGScope::TStorage< TTypes >
 
class  TRDGEventScopeGuard< TScopeType >
 
class  FRDGScopeState
 
struct  FRDGScopeState::FState
 

Namespaces

namespace  DynamicRenderScaling
 

Macros

#define RDG_EVENT_NAME(...)   FRDGEventName()
 
#define RDG_EVENT_SCOPE(...)   do { } while (false)
 
#define RDG_EVENT_SCOPE_STAT(...)   do { } while (false)
 
#define RDG_EVENT_SCOPE_CONDITIONAL(...)   do { } while (false)
 
#define RDG_EVENT_SCOPE_CONDITIONAL_STAT(...)   do { } while (false)
 
#define RDG_EVENT_SCOPE_FINAL(...)   do { } while (false)
 
#define RDG_EVENT_SCOPE_CONDITIONAL_NAME(...)   do { } while (false)
 
#define RDG_GPU_STAT_SCOPE(GraphBuilder, StatName)
 
#define RDG_GPU_STAT_SCOPE_VERBOSE(GraphBuilder, StatName, Description)
 
#define RDG_CSV_STAT_EXCLUSIVE_SCOPE(GraphBuilder, StatName)
 
#define RDG_RHI_EVENT_SCOPE( GraphBuilder, Name)   RDG_EVENT_SCOPE(GraphBuilder, #Name); RHI_BREADCRUMB_EVENT(GraphBuilder.RHICmdList, #Name)
 
#define RDG_RHI_EVENT_SCOPE_STAT(GraphBuilder, Stat, Name)   RDG_EVENT_SCOPE_STAT(GraphBuilder, Stat, #Name); RHI_BREADCRUMB_EVENT_STAT(GraphBuilder.RHICmdList, Stat, #Name)
 
#define RDG_RHI_GPU_STAT_SCOPE( GraphBuilder, StatName)   RDG_GPU_STAT_SCOPE(GraphBuilder, StatName); SCOPED_GPU_STAT(GraphBuilder.RHICmdList, StatName);
 

Enumerations

enum class  ERDGScopeFlags : uint8 { None = 0 , Final = 1 << 0 , AlwaysEnable = 1 << 1 , Stat = 1 << 2 }
 
enum class  ERDGScopeMode : uint8 { Disabled = 0 , TopLevelOnly = 1 , AllEvents = 2 , AllEventsAndPassNames = 3 }
 

Functions

 ENUM_CLASS_FLAGS (ERDGScopeFlags)
 

Macro Definition Documentation

◆ RDG_CSV_STAT_EXCLUSIVE_SCOPE

#define RDG_CSV_STAT_EXCLUSIVE_SCOPE (   GraphBuilder,
  StatName 
)

◆ RDG_EVENT_NAME

#define RDG_EVENT_NAME (   ...)    FRDGEventName()

Macros for create render graph event names and scopes.

FRDGEventName Name = RDG_EVENT_NAME("MyPass %sx%s", ViewRect.Width(), ViewRect.Height());

RDG_EVENT_SCOPE(GraphBuilder, "MyProcessing %sx%s", ViewRect.Width(), ViewRect.Height());

◆ RDG_EVENT_SCOPE

#define RDG_EVENT_SCOPE (   ...)    do { } while (false)

◆ RDG_EVENT_SCOPE_CONDITIONAL

#define RDG_EVENT_SCOPE_CONDITIONAL (   ...)    do { } while (false)

◆ RDG_EVENT_SCOPE_CONDITIONAL_NAME

#define RDG_EVENT_SCOPE_CONDITIONAL_NAME (   ...)    do { } while (false)

◆ RDG_EVENT_SCOPE_CONDITIONAL_STAT

#define RDG_EVENT_SCOPE_CONDITIONAL_STAT (   ...)    do { } while (false)

◆ RDG_EVENT_SCOPE_FINAL

#define RDG_EVENT_SCOPE_FINAL (   ...)    do { } while (false)

◆ RDG_EVENT_SCOPE_STAT

#define RDG_EVENT_SCOPE_STAT (   ...)    do { } while (false)

◆ RDG_GPU_STAT_SCOPE

#define RDG_GPU_STAT_SCOPE (   GraphBuilder,
  StatName 
)

◆ RDG_GPU_STAT_SCOPE_VERBOSE

#define RDG_GPU_STAT_SCOPE_VERBOSE (   GraphBuilder,
  StatName,
  Description 
)

◆ RDG_RHI_EVENT_SCOPE

#define RDG_RHI_EVENT_SCOPE (   GraphBuilder,
  Name 
)    RDG_EVENT_SCOPE(GraphBuilder, #Name); RHI_BREADCRUMB_EVENT(GraphBuilder.RHICmdList, #Name)

Injects a scope onto both the RDG and RHI timeline.

◆ RDG_RHI_EVENT_SCOPE_STAT

#define RDG_RHI_EVENT_SCOPE_STAT (   GraphBuilder,
  Stat,
  Name 
)    RDG_EVENT_SCOPE_STAT(GraphBuilder, Stat, #Name); RHI_BREADCRUMB_EVENT_STAT(GraphBuilder.RHICmdList, Stat, #Name)

◆ RDG_RHI_GPU_STAT_SCOPE

#define RDG_RHI_GPU_STAT_SCOPE (   GraphBuilder,
  StatName 
)    RDG_GPU_STAT_SCOPE(GraphBuilder, StatName); SCOPED_GPU_STAT(GraphBuilder.RHICmdList, StatName);

Enumeration Type Documentation

◆ ERDGScopeFlags

enum class ERDGScopeFlags : uint8
strong
Enumerator
None 
Final 
AlwaysEnable 
Stat 

◆ ERDGScopeMode

enum class ERDGScopeMode : uint8
strong
Enumerator
Disabled 
TopLevelOnly 
AllEvents 
AllEventsAndPassNames 

Function Documentation

◆ ENUM_CLASS_FLAGS()

ENUM_CLASS_FLAGS ( ERDGScopeFlags  )