1. Epic GamesDeveloper
  3. FRDGBuilder

FRDGBuilder

Use the render graph builder to build up a graph of passes and then call Execute() to process them.

API > API/Runtime > API/Runtime/RenderCore

Use the render graph builder to build up a graph of passes and then call Execute() to process them. Resource barriers and lifetimes are derived from RDG parameters in the pass parameter struct provided to each AddPass call. The resulting graph is compiled, culled, and executed in Execute(). The builder should be created on the stack and executed prior to destruction.

   
Name FRDGBuilder
Type class
Header File /Engine/Source/Runtime/RenderCore/Public/RenderGraphBuilder.h
Include Path #include "RenderGraphBuilder.h"

Syntax

class FRDGBuilder : public FRDGScopeState

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  RenderGraphBuilder.h  
  RenderGraphBuilder.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FRDGBuilder()

   RenderGraphBuilder.h  

Structs

Name Remarks
FAsyncDeleter  
FAsyncSetupOp  
FAsyncSetupQueue  
FAuxiliaryPass Tracks stack counters of auxiliary passes to avoid calling them recursively.
FCollectResourceContext A temporary context used to collect resources for allocation.
FCollectResourceOp  
FExtractedBuffer  
FExtractedTexture  
FParallelExecute  
FUploadedBuffer  

Typedefs

Name Type Remarks Include Path
FCollectResourceOpArray TArray< FCollectResourceOp, FRDGArrayAllocator >   RenderGraphBuilder.h

Constants

Name Type Remarks Include Path
kDefaultUnaccountedCSVStat const char *const   RenderGraphBuilder.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bEnabled bool   RenderGraphBuilder.h  
Blackboard FRDGBlackboard The blackboard used to hold common data tied to the graph lifetime. RenderGraphBuilder.h  
TaskPriorityBias int8   RenderGraphBuilder.h  
Tasks TStaticArray< TArray< UE::Tasks::FTask, FRDGArrayAllocator >,(int32) ERDGSetupTaskWaitPoint::MAX > Array of all tasks for variants of AddSetupTask. RenderGraphBuilder.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AccessModeQueue TArray< FRDGViewableResource *, FRDGArrayAllocator > Contains resources queued for either access mode change passes. RenderGraphBuilder.h  
ActivePooledBuffers TArray< TRefCountPtr< FRDGPooledBuffer >, FRDGArrayAllocator >   RenderGraphBuilder.h  
ActivePooledTextures TArray< TRefCountPtr< IPooledRenderTarget >, FRDGArrayAllocator > Array of all pooled references held during execution. RenderGraphBuilder.h  
AsyncComputePassCount uint32   RenderGraphBuilder.h  
AsyncDeleter FRDGBuilder::FAsyncDeleter   RenderGraphBuilder.h  
AsyncSetupQueue FRDGBuilder::FAsyncSetupQueue   RenderGraphBuilder.h  
AuxiliaryPasses FRDGBuilder::FAuxiliaryPass   RenderGraphBuilder.h  
BarrierBatchMap TMap< FRDGBarrierBatchBeginId, FRDGBarrierBatchBegin *, FRDGSetAllocator > Map of barrier batches begun from more than one pipe. RenderGraphBuilder.h  
BarrierValidation FRDGBarrierValidation   RenderGraphBuilder.h  
bCompiling bool   RenderGraphBuilder.h  
bFlushResourcesRHI bool   RenderGraphBuilder.h  
bInitialAsyncComputeFence bool   RenderGraphBuilder.h  
bParallelCompileEnabled bool   RenderGraphBuilder.h  
bSupportsAsyncCompute bool   RenderGraphBuilder.h  
bSupportsRenderPassMerge bool   RenderGraphBuilder.h  
bSupportsTransientBuffers bool   RenderGraphBuilder.h  
bSupportsTransientTextures bool   RenderGraphBuilder.h  
Buffers FRDGBufferRegistry   RenderGraphBuilder.h  
BuilderName const FRDGEventName   RenderGraphBuilder.h  
CullPassStack TArray< FRDGPass *, FRDGArrayAllocator >   RenderGraphBuilder.h  
DispatchPasses TArray< FRDGDispatchPass *, FRDGArrayAllocator > Tracks dispatch passes that need to launch tasks. RenderGraphBuilder.h  
EpiloguePass FRDGPass *   RenderGraphBuilder.h  
EpilogueResourceAccesses TArray< FRHITrackedAccessInfo, FRDGArrayAllocator > Tracks the final access used on resources in order to call SetTrackedAccess. RenderGraphBuilder.h  
ExtendResourceLifetimeScope FRHICommandListScopedExtendResourceLifetime   RenderGraphBuilder.h  
ExternalAccessResources TSet< FRDGViewableResource *, DefaultKeyFuncs< FRDGViewableResource * >, FRDGSetAllocator >   RenderGraphBuilder.h  
ExternalBuffers Experimental::TRobinHoodHashMap< FRHIBuffer *, FRDGBuffer *, DefaultKeyFuncs< FRHIBuffer * >, FRDGArrayAllocator >   RenderGraphBuilder.h  
ExternalTextures Experimental::TRobinHoodHashMap< FRHITexture *, FRDGTexture *, DefaultKeyFuncs< FRHITexture * >, FRDGArrayAllocator > Tracks external resources to their registered render graph counterparts for de-duplication. RenderGraphBuilder.h  
ExtractedBuffers TArray< FExtractedBuffer, FRDGArrayAllocator >   RenderGraphBuilder.h  
ExtractedTextures TArray< FExtractedTexture, FRDGArrayAllocator >   RenderGraphBuilder.h  
FRDGAsyncComputeBudgetScopeGuard friend   RenderGraphBuilder.h  
FRDGDispatchPassBuilder friend   RenderGraphBuilder.h  
FRDGScopedCsvStatExclusive friend   RenderGraphBuilder.h  
FRDGScopedCsvStatExclusiveConditional friend   RenderGraphBuilder.h  
FRDGTrace friend   RenderGraphBuilder.h  
NumElementsCallbackBuffers TArray< FRDGBuffer *, FRDGArrayAllocator > Tracks buffers that have a defered num elements callback. RenderGraphBuilder.h  
ParallelExecute FRDGBuilder::FParallelExecute   RenderGraphBuilder.h  
ParallelSetup FRDGBuilder   RenderGraphBuilder.h  
Passes FRDGPassRegistry Registry of graph objects. RenderGraphBuilder.h  
PooledBufferOwnershipMap Experimental::TRobinHoodHashMap< FRDGPooledBuffer *, FRDGBuffer *, DefaultKeyFuncs< FRDGPooledBuffer * >, FConcurrentLinearArrayAllocator >   RenderGraphBuilder.h  
PooledTextureOwnershipMap Experimental::TRobinHoodHashMap< FRDGPooledTexture *, FRDGTexture *, DefaultKeyFuncs< FRDGPooledTexture * >, FConcurrentLinearArrayAllocator > Tracks the latest RDG resource to own an alias of a pooled resource (multiple RDG resources can reference the same pooled resource). RenderGraphBuilder.h  
PostExecuteCallbacks TArray< TUniqueFunction< void()>, FRDGArrayAllocator >   RenderGraphBuilder.h  
ProloguePass FRDGPass * The epilogue and prologue passes are sentinels that are used to simplify graph logic around barriers and traversal. RenderGraphBuilder.h  
PrologueSubresourceState FRDGSubresourceState Subresource state representing the graph prologue. Used for immediate mode. RenderGraphBuilder.h  
RasterPassCount uint32   RenderGraphBuilder.h  
ReservedBufferCommitSizes TArray< uint64, FRDGArrayAllocator >   RenderGraphBuilder.h  
RootAllocatorScope FRDGAllocatorScope   RenderGraphBuilder.h  
ScratchTextureState FRDGTextureSubresourceState Texture state used for intermediate operations. Held here to avoid re-allocating. RenderGraphBuilder.h  
Textures FRDGTextureRegistry   RenderGraphBuilder.h  
TransientResourceAllocator IRHITransientResourceAllocator *   RenderGraphBuilder.h  
TransitionCreateQueue FRDGTransitionCreateQueue Set of all active barrier batch begin instances; used to create transitions. RenderGraphBuilder.h  
UniformBuffers FRDGUniformBufferRegistry   RenderGraphBuilder.h  
UploadedBuffers TArray< FUploadedBuffer, FRDGArrayAllocator >   RenderGraphBuilder.h  
UserValidation FRDGUserValidation   RenderGraphBuilder.h  
Views FRDGViewRegistry   RenderGraphBuilder.h  
WaitOutstandingTasks FGraphEventArray   RenderGraphBuilder.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UE::Tasks::FTask AddCommandListSetupTask ( TaskLambdaType&& TaskLambda,
PrerequisitesCollectionType&& Prerequisites,
UE::Tasks::ETaskPriority Priority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

      

UE::Tasks::FTask AddCommandListSetupTask ( TaskLambdaType&& TaskLambda,
UE::Tasks::FPipe* Pipe,
UE::Tasks::ETaskPriority Priority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

      

UE::Tasks::FTask AddCommandListSetupTask ( TaskLambda&& Task,
PrerequisitesCollectionType&& Prerequisites,
UE::Tasks::ETaskPriority Priority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

   RenderGraphBuilder.h  

UE::Tasks::FTask AddCommandListSetupTask ( TaskLambda&& Task,
UE::Tasks::FPipe* Pipe,
UE::Tasks::ETaskPriority Priority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

   RenderGraphBuilder.h  

UE::Tasks::FTask AddCommandListSetupTask ( TaskLambdaType&& TaskLambda,
UE::Tasks::ETaskPriority TaskPriority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

      

UE::Tasks::FTask AddCommandListSetupTask ( TaskLambda&& Task,
UE::Tasks::ETaskPriority Priority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

   RenderGraphBuilder.h  

UE::Tasks::FTask AddCommandListSetupTask ( TaskLambdaType&& TaskLambda,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

      

UE::Tasks::FTask AddCommandListSetupTask ( TaskLambda&& Task,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

 Launches a task that is synced prior to graph execution. RenderGraphBuilder.h  

UE::Tasks::FTask AddCommandListSetupTask ( TaskLambdaType&& TaskLambda,
UE::Tasks::FPipe* Pipe,
PrerequisitesCollectionType&& Prerequisites,
UE::Tasks::ETaskPriority Priority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

      

UE::Tasks::FTask AddCommandListSetupTask ( TaskLambda&& Task,
UE::Tasks::FPipe* Pipe,
PrerequisitesCollectionType&& Prerequisites,
UE::Tasks::ETaskPriority Priority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

   RenderGraphBuilder.h  

void AddDispatchHint()

 A hint to the builder to flush work to the RHI thread after the last queued pass on the execution timeline. RenderGraphBuilder.h  

FRDGPassRef AddDispatchPass ( FRDGEventName&& Name,
const ParameterStructType* ParameterStruct,
ERDGPassFlags Flags,
LaunchLambdaType&& LaunchLambda
)

 Adds a pass that takes a FRDGDispatchPassBuilder instead of a RHI command list. RenderGraphBuilder.h  

FRDGPass * AddDispatchPass ( FRDGEventName&& Name,
const ParameterStructType* ParameterStruct,
ERDGPassFlags Flags,
LaunchLambdaType&& LaunchLambda
)

      

FRDGPass * AddPass ( FRDGEventName&& Name,
const FShaderParametersMetadata* ParametersMetadata,
const void* ParameterStruct,
ERDGPassFlags Flags,
ExecuteLambdaType&& ExecuteLambda
)

      

FRDGPassRef AddPass ( FRDGEventName&& Name,
const FShaderParametersMetadata* ParametersMetadata,
const void* ParameterStruct,
ERDGPassFlags Flags,
ExecuteLambdaType&& ExecuteLambda
)

 Adds a lambda pass to the graph with a runtime-generated parameter struct. RenderGraphBuilder.h  

FRDGPass * AddPass ( FRDGEventName&& Name,
const ParameterStructType* ParameterStruct,
ERDGPassFlags Flags,
ExecuteLambdaType&& ExecuteLambda
)

      

FRDGPassRef AddPass ( FRDGEventName&& Name,
const ParameterStructType* ParameterStruct,
ERDGPassFlags Flags,
ExecuteLambdaType&& ExecuteLambda
)

 Adds a lambda pass to the graph with an accompanied pass parameter struct. RenderGraphBuilder.h  

FRDGPass * AddPass ( FRDGEventName&& Name,
ERDGPassFlags Flags,
ExecuteLambdaType&& ExecuteLambda
)

      

FRDGPassRef AddPass ( FRDGEventName&& Name,
ERDGPassFlags Flags,
ExecuteLambdaType&& ExecuteLambda
)

 Adds a lambda pass to the graph without any parameters. RenderGraphBuilder.h  

void AddPassDependency ( FRDGPass* Producer,
FRDGPass* Consumer
)

 Adds a user-defined dependency between two passes. RenderGraphBuilder.h  

void AddPostExecuteCallback ( TUniqueFunction< void()>&& Callback
)

 Adds a callback that is called after pass execution is complete. RenderGraphBuilder.h  

UE::Tasks::FTask AddSetupTask ( TaskLambda&& Task,
PrerequisitesCollectionType&& Prerequisites,
UE::Tasks::ETaskPriority Priority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

   RenderGraphBuilder.h  

UE::Tasks::FTask AddSetupTask ( TaskLambda&& Task,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

 Launches a task that is synced prior to graph execution. RenderGraphBuilder.h  

UE::Tasks::FTask AddSetupTask ( TaskLambdaType&& TaskLambda,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

      

UE::Tasks::FTask AddSetupTask ( TaskLambda&& Task,
UE::Tasks::ETaskPriority Priority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

   RenderGraphBuilder.h  

UE::Tasks::FTask AddSetupTask ( TaskLambdaType&& TaskLambda,
UE::Tasks::ETaskPriority Priority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

      

UE::Tasks::FTask AddSetupTask ( TaskLambda&& Task,
UE::Tasks::FPipe* Pipe,
UE::Tasks::ETaskPriority Priority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

   RenderGraphBuilder.h  

UE::Tasks::FTask AddSetupTask ( TaskLambdaType&& TaskLambda,
UE::Tasks::FPipe* Pipe,
UE::Tasks::ETaskPriority Priority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

      

UE::Tasks::FTask AddSetupTask ( TaskLambdaType&& TaskLambda,
UE::Tasks::FPipe* Pipe,
PrerequisitesCollectionType&& Prerequisites,
UE::Tasks::ETaskPriority Priority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

      

UE::Tasks::FTask AddSetupTask ( TaskLambdaType&& TaskLambda,
PrerequisitesCollectionType&& Prerequisites,
UE::Tasks::ETaskPriority Priority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

      

UE::Tasks::FTask AddSetupTask ( TaskLambda&& Task,
UE::Tasks::FPipe* Pipe,
PrerequisitesCollectionType&& Prerequisites,
UE::Tasks::ETaskPriority Priority,
bool bCondition,
ERDGSetupTaskWaitPoint WaitPoint
)

   RenderGraphBuilder.h  

void AddTextureTransition ( FRDGTexture* Texture,
FRDGTextureSubresourceState& StateBefore,
FRDGTextureSubresourceState& StateAfter,
FilterSubresourceLambdaType&& FilterSubresourceLambda
)

      

void * Alloc ( uint64 SizeInBytes,
uint32 AlignInBytes
)

 Allocates raw memory using an allocator tied to the lifetime of the graph. RenderGraphBuilder.h  

TArray< ObjectType, SceneRenderingAllocator > & AllocArray ()

 Allocates a C++ array where both the array and the data are tied to the lifetime of the graph. RenderGraphBuilder.h  

ObjectType * AllocObject ( TArgs&&... Args
)

 Allocates a C++ object using an allocator tied to the lifetime of the graph. RenderGraphBuilder.h  

ParameterStructType * AllocParameters ()

 Allocates a parameter struct with a lifetime tied to graph execution. RenderGraphBuilder.h  

ParameterStructType * AllocParameters ( const ParameterStructType* StructToCopy
)

 Allocates a parameter struct with a lifetime tied to graph execution, and copies contents from an existing parameters struct. RenderGraphBuilder.h  

BaseParameterStructType * AllocParameters ( const FShaderParametersMetadata* ParametersMetadata
)

 Allocates a data-driven parameter struct with a lifetime tied to graph execution. RenderGraphBuilder.h  

TStridedView< BaseParameterStructType > AllocParameters ( const FShaderParametersMetadata* ParametersMetadata,
uint32 NumStructs
)

 Allocates an array of data-driven parameter structs with a lifetime tied to graph execution. RenderGraphBuilder.h  

PODType * AllocPOD ()

 Allocates POD memory using an allocator tied to the lifetime of the graph. RenderGraphBuilder.h  

PODType * AllocPODArray ( uint32 Count
)

 Allocates POD memory using an allocator tied to the lifetime of the graph. RenderGraphBuilder.h  

TArrayView< PODType > AllocPODArrayView ( uint32 Count
)

 Allocates POD memory using an allocator tied to the lifetime of the graph. RenderGraphBuilder.h  

const TRefCountPtr< FRDGPooledBuffer > & ConvertToExternalBuffer ( FRDGBufferRef Buffer
)

   RenderGraphBuilder.h  

const TRefCountPtr< IPooledRenderTarget > & ConvertToExternalTexture ( FRDGTextureRef Texture
)

 For graph-created resources, this forces immediate allocation of the underlying pooled resource, effectively promoting it to an external resource. RenderGraphBuilder.h  

FRHIUniformBuffer * ConvertToExternalUniformBuffer ( FRDGUniformBufferRef UniformBuffer
)

 For a graph-created uniform buffer, this forces immediate allocation of the underlying resource, effectively promoting it to an external resource. RenderGraphBuilder.h  

FRDGBufferRef CreateBuffer ( const FRDGBufferDesc& Desc,
const TCHAR* Name,
FRDGBufferNumElementsCallback&& NumElementsCallback,
ERDGBufferFlags Flags
)

 A variant of CreateBuffer where users supply NumElements through a callback. RenderGraphBuilder.h  

FRDGBufferRef CreateBuffer ( const FRDGBufferDesc& Desc,
const TCHAR* Name,
ERDGBufferFlags Flags
)

 Create graph tracked buffer from a descriptor. RenderGraphBuilder.h  

FRDGBufferSRVRef CreateSRV ( FRDGBufferRef Buffer,
EPixelFormat Format
)

   RenderGraphBuilder.h  

FRDGBufferSRVRef CreateSRV ( const FRDGBufferSRVDesc& Desc
)

 Create graph tracked SRV for a buffer from a descriptor. RenderGraphBuilder.h  

FRDGTextureSRVRef CreateSRV ( const FRDGTextureSRVDesc& Desc
)

 Create graph tracked SRV for a texture from a descriptor. RenderGraphBuilder.h  

FRDGTextureRef CreateTexture ( const FRDGTextureDesc& Desc,
const TCHAR* Name,
ERDGTextureFlags Flags
)

 Create graph tracked texture from a descriptor. RenderGraphBuilder.h  

FRDGTextureUAVRef CreateUAV ( const FRDGTextureUAVDesc& Desc,
ERDGUnorderedAccessViewFlags Flags
)

 Create graph tracked UAV for a texture from a descriptor. RenderGraphBuilder.h  

FRDGTextureUAVRef CreateUAV ( FRDGTextureRef Texture,
ERDGUnorderedAccessViewFlags Flags,
EPixelFormat Format
)

   RenderGraphBuilder.h  

FRDGBufferUAVRef CreateUAV ( FRDGBufferRef Buffer,
EPixelFormat Format,
ERDGUnorderedAccessViewFlags Flags
)

   RenderGraphBuilder.h  

FRDGBufferUAVRef CreateUAV ( const FRDGBufferUAVDesc& Desc,
ERDGUnorderedAccessViewFlags Flags
)

 Create graph tracked UAV for a buffer from a descriptor. RenderGraphBuilder.h  

TRDGUniformBufferRef< ParameterStructType > CreateUniformBuffer ( const ParameterStructType* ParameterStruct
)

 Creates a graph tracked uniform buffer which can be attached to passes. RenderGraphBuilder.h  

void Execute()

 Executes the queued passes, managing setting of render targets (RHI RenderPasses), resource transitions and queued texture extraction. RenderGraphBuilder.h  
Finds an RDG buffer associated with the external buffer, or returns null if none is found. RenderGraphBuilder.h  

FRDGBuffer * FindExternalBuffer ( FRDGPooledBuffer* ExternalPooledBuffer
) const

   RenderGraphBuilder.h  
Finds an RDG texture associated with the external texture, or returns null if none is found. RenderGraphBuilder.h  

FRDGTexture * FindExternalTexture ( IPooledRenderTarget* ExternalPooledTexture
) const

   RenderGraphBuilder.h  

void FlushSetupQueue()

 Flushes all queued passes to an async task to perform setup work. RenderGraphBuilder.h  

const TRefCountPtr< FRDGPooledBuffer > & GetPooledBuffer ( FRDGBufferRef Buffer
) const

   RenderGraphBuilder.h  

const TRefCountPtr< IPooledRenderTarget > & GetPooledTexture ( FRDGTextureRef Texture
) const

 Performs an immediate query for the underlying pooled resource. RenderGraphBuilder.h  

bool IsAsyncComputeEnabled()

   RenderGraphBuilder.h  

bool IsParallelSetupEnabled()

 Whether RDG will launch async tasks when AddSetup{CommandList}Task is called. RenderGraphBuilder.h  

void QueueBufferExtraction ( FRDGBufferRef Buffer,
TRefCountPtr< FRDGPooledBuffer >* OutPooledBufferPtr
)

 Queues a pooled buffer extraction to happen at the end of graph execution. RenderGraphBuilder.h  

void QueueBufferExtraction ( FRDGBufferRef Buffer,
TRefCountPtr< FRDGPooledBuffer >* OutPooledBufferPtr,
ERHIAccess AccessFinal
)

   RenderGraphBuilder.h  

void QueueBufferUpload ( FRDGBufferRef Buffer,
FRDGBufferInitialDataFillCallback&& InitialDataFillCallback
)

 A variant where the buffer is mapped and the pointer / size is provided to the callback to fill the buffer pointer. RenderGraphBuilder.h  

void QueueBufferUpload ( FRDGBufferRef Buffer,
TArrayView< ElementType, int32 > Container,
ERDGInitialDataFlags InitialDataFlags
)

   RenderGraphBuilder.h  

void QueueBufferUpload ( FRDGBufferRef Buffer,
TArrayView< ElementType, int32 > Container,
FRDGBufferInitialDataFreeCallback&& InitialDataFreeCallback
)

   RenderGraphBuilder.h  

void QueueBufferUpload ( FRDGBufferRef Buffer,
FRDGBufferInitialDataCallback&& InitialDataCallback,
FRDGBufferInitialDataSizeCallback&& InitialDataSizeCallback
)

 A variant where InitialData and InitialDataSize are supplied through callbacks. RenderGraphBuilder.h  

void QueueBufferUpload ( FRDGBufferRef Buffer,
const void* InitialData,
uint64 InitialDataSize,
ERDGInitialDataFlags InitialDataFlags
)

 Queues a buffer upload operation prior to execution. RenderGraphBuilder.h  

void QueueBufferUpload ( FRDGBufferRef Buffer,
const void* InitialData,
uint64 InitialDataSize,
FRDGBufferInitialDataFreeCallback&& InitialDataFreeCallback
)

 Queues a buffer upload operation prior to execution. RenderGraphBuilder.h  

void QueueBufferUpload ( FRDGBufferRef Buffer,
FRDGBufferInitialDataCallback&& InitialDataCallback,
FRDGBufferInitialDataSizeCallback&& InitialDataSizeCallback,
FRDGBufferInitialDataFreeCallback&& InitialDataFreeCallback
)

   RenderGraphBuilder.h  

void QueueCommitReservedBuffer ( FRDGBufferRef Buffer,
uint64 CommitSizeInBytes
)

 Queues a reserved buffer commit on first use of the buffer in the graph. RenderGraphBuilder.h  

void QueueTextureExtraction ( FRDGTextureRef Texture,
TRefCountPtr< IPooledRenderTarget >* OutPooledTexturePtr,
ERHIAccess AccessFinal,
ERDGResourceExtractionFlags Flags
)

   RenderGraphBuilder.h  

void QueueTextureExtraction ( FRDGTextureRef Texture,
TRefCountPtr< IPooledRenderTarget >* OutPooledTexturePtr,
ERDGResourceExtractionFlags Flags
)

 Queues a pooled render target extraction to happen at the end of graph execution. RenderGraphBuilder.h  

FRDGBufferRef RegisterExternalBuffer ( const TRefCountPtr< FRDGPooledBuffer >& ExternalPooledBuffer,
ERDGBufferFlags Flags,
ERHIAccess AccessFinal
)

   RenderGraphBuilder.h  

FRDGBufferRef RegisterExternalBuffer ( const TRefCountPtr< FRDGPooledBuffer >& ExternalPooledBuffer,
const TCHAR* NameIfNotRegistered,
ERDGBufferFlags Flags
)

 Register an external buffer with a custom name. RenderGraphBuilder.h  

FRDGBufferRef RegisterExternalBuffer ( const TRefCountPtr< FRDGPooledBuffer >& ExternalPooledBuffer,
ERDGBufferFlags Flags
)

 Register a external buffer to be tracked by the render graph. RenderGraphBuilder.h  

FRDGTextureRef RegisterExternalTexture ( const TRefCountPtr< IPooledRenderTarget >& ExternalPooledTexture,
ERDGTextureFlags Flags
)

 Registers a external pooled render target texture to be tracked by the render graph. RenderGraphBuilder.h  

FRDGTextureRef RegisterExternalTexture ( const TRefCountPtr< IPooledRenderTarget >& ExternalPooledTexture,
const TCHAR* NameIfNotRegistered,
ERDGTextureFlags Flags
)

 Register an external texture with a custom name. RenderGraphBuilder.h  

void RemoveUnusedBufferWarning ( FRDGBufferRef Buffer
)

   RenderGraphBuilder.h  

void RemoveUnusedTextureWarning ( FRDGTextureRef Texture
)

   RenderGraphBuilder.h  

void SetBufferAccessFinal ( FRDGBufferRef Buffer,
ERHIAccess Access
)

 (External | Extracted only) Sets the access to transition to after execution at the end of the graph. RenderGraphBuilder.h  

void SetCommandListStat ( TStatId StatId
)

 Sets the current command list stat for all subsequent passes. RenderGraphBuilder.h  
Tells the builder to delete unused RHI resources. RenderGraphBuilder.h  

void SetPassWorkload ( FRDGPass* Pass,
uint32 Workload
)

 Sets the expected workload of the pass execution lambda. RenderGraphBuilder.h  

void SetTextureAccessFinal ( FRDGTextureRef Texture,
ERHIAccess Access
)

 (External | Extracted only) Sets the access to transition to after execution at the end of the graph. RenderGraphBuilder.h  
Tells the RDG Builder that it is safe not to issue a fence from Async Compute -> Graphics at the start of the graph. RenderGraphBuilder.h  

void UseExternalAccessMode ( FRDGViewableResource* Resource,
ERHIAccess ReadOnlyAccess,
ERHIPipeline Pipelines
)

 Configures the resource for external access for all subsequent passes, or until UseInternalAccessMode is called. RenderGraphBuilder.h  

void UseExternalAccessMode ( TArrayView< FRDGViewableResource*const > Resources,
ERHIAccess ReadOnlyAccess,
ERHIPipeline Pipelines
)

   RenderGraphBuilder.h  
Use this method to resume tracking of a resource after calling UseExternalAccessMode. RenderGraphBuilder.h  
  RenderGraphBuilder.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString BeginResourceDump ( const TCHAR* Cmd
)

   RenderGraphBuilder.h  

static void DumpDraw ( const FRDGEventName& DrawEventName
)

   RenderGraphBuilder.h  

static void ExecutePass ( FRHIComputeCommandList& RHICmdListPass,
FRDGPass* Pass
)

   RenderGraphBuilder.h  

static void ExecutePassEpilogue ( FRHIComputeCommandList& RHICmdListPass,
FRDGPass* Pass
)

   RenderGraphBuilder.h  

static void ExecutePassPrologue ( FRHIComputeCommandList& RHICmdListPass,
FRDGPass* Pass
)

   RenderGraphBuilder.h  

static const UE::Tasks::FTask & GetAsyncDeleteTask()

 Returns the last RDG chained deletion task that was launched. RenderGraphBuilder.h  

static const UE::Tasks::FTask & GetAsyncExecuteTask()

 Returns the last RDG chained execution task that was launched. RenderGraphBuilder.h  

static bool IsDumpingDraws()

   RenderGraphBuilder.h  

static bool IsDumpingFrame()

   RenderGraphBuilder.h  

static bool IsImmediateMode()

 Whether RDG is running in immediate mode. RenderGraphBuilder.h  

static void PopPassScopes ( FRHIComputeCommandList& RHICmdListPass,
FRDGPass* Pass
)

   RenderGraphBuilder.h  

static void PopPreScopes ( FRHIComputeCommandList& RHICmdListPass,
FRDGPass* LastPass
)

   RenderGraphBuilder.h  

static void PushPassScopes ( FRHIComputeCommandList& RHICmdListPass,
FRDGPass* Pass
)

   RenderGraphBuilder.h  

static void PushPreScopes ( FRHIComputeCommandList& RHICmdListPass,
FRDGPass* FirstPass
)

   RenderGraphBuilder.h  

static void TickPoolElements()

 Per-frame update of the render graph resource pool. RenderGraphBuilder.h  

static void WaitForAsyncDeleteTask ()

 Waits for the last RDG async delete task that was launched. RenderGraphBuilder.h  

static void WaitForAsyncExecuteTask()

 Waits for the last RDG chained execution task that was launched. RenderGraphBuilder.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page