1. Epic GamesDeveloper
  3. FRDGUserValidation

FRDGUserValidation

Used by the render graph builder to validate correct usage of the graph API from setup to execution.

API > API/Runtime > API/Runtime/RenderCore

References

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

Syntax

class FRDGUserValidation

Remarks

Used by the render graph builder to validate correct usage of the graph API from setup to execution. Validation is compiled out in shipping builds. This class tracks resources and passes as they are added to the graph. It will then validate execution of the graph, including whether resources are used during execution, and that they are properly produced before being consumed. All found issues must be clear enough to help the user identify the problem in client code. Validation should occur as soon as possible in the graph lifecycle. It's much easier to catch an issue at the setup location rather than during deferred execution.

Finally, this class is designed for user validation, not for internal graph validation. In other words, if the user can break the graph externally via the client-facing API, this validation layer should catch it. Any internal validation of the graph state should be kept out of this class in order to provide a clear and modular location to extend the validation layer as well as clearly separate the graph implementation details from events in the graph.

Constructors

  Type Name Description
Public function    
Public function  

FRDGUserValidation ( FRDGAllocator& Allocator,
bool bParallelExecuteEnabled
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Removes the 'produced but not used' warning from the requested resource.
Public function Static void

SetAllowRHIAccess ( const FRDGPass* Pass,
bool bAllowAccess
)

 Traverses all resources in the pass and marks whether they are externally accessible by user pass implementations.
Public function Const bool Attempts to mark a resource for clobbering. If already marked, returns false.
Public function void

ValidateAddPass ( const void* ParameterStruct,
const FShaderParametersMetadata* Metadata,
const FRDGEventName& Name,
ERDGPassFlags Flags
)

 Tracks and validates the addition of a new pass to the graph.
Public function void

ValidateAddPass ( const FRDGEventName& Name,
ERDGPassFlags Flags
)

 Tracks and validates the addition of a new pass to the graph.
Public function void

ValidateAddPass ( const FRDGPass* Pass,
bool bSkipPassAccessMarking
)

 Tracks and validates the addition of a new pass to the graph.
Public function void

ValidateAddSubresourceAccess ( FRDGViewableResource* Resource,
const FRDGSubresourceState& Subresource,
ERHIAccess Access
)

  
Public function void  
Public function void  
Public function void

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

  
Public function void

ValidateCreateBuffer ( FRDGBufferRef Buffer
)

  
Public function void  
Public function void

ValidateCreateSRV ( FRDGTextureSRVRef SRV
)

  
Public function void  
Public function void

ValidateCreateSRV ( FRDGBufferSRVRef SRV
)

  
Public function void

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

 Tracks and validates inputs into resource creation functions.
Public function void

ValidateCreateTexture ( FRDGTextureRef Texture
)

 Tracks and validates the creation of a new externally created / registered resource instances.
Public function void  
Public function void  
Public function void

ValidateCreateUAV ( FRDGTextureUAVRef UAV
)

  
Public function void

ValidateCreateUAV ( FRDGBufferUAVRef UAV
)

  
Public function void

ValidateCreateUniformBuffer ( FRDGUniformBufferRef UniformBuffer
)

  
Public function void

ValidateCreateUniformBuffer ( const void* ParameterStruct,
const FShaderParametersMetadata* Metadata
)

  
Public function void Validate graph state before and after execution.
Public function void  
Public function void Validate pass state before and after execution.
Public function void  
Public function void

ValidateExternalAccess ( FRDGViewableResource* Resource,
ERHIAccess Access,
const FRDGPass* Pass
)

  
Public function void

ValidateExtractBuffer ( FRDGBufferRef Buffer,
TRefCountPtr< FRDGPooledBuffer >* OutBufferPtr
)

  
Public function void

ValidateExtractTexture ( FRDGTextureRef Texture,
TRefCountPtr< IPooledRenderTarget >* OutTexturePtr
)

 Validates a resource extraction operation.
Public function Const void

ValidateGetPooledBuffer ( FRDGBufferRef Buffer
)

  
Public function Const void

ValidateGetPooledTexture ( FRDGTextureRef Texture
)

  
Public function void

ValidateRegisterExternalBuffer ( FRDGBufferRef Buffer
)

  
Public function void

ValidateRegisterExternalBuffer ( const TRefCountPtr< FRDGPooledBuffer >& ExternalPooledBuffer,
const TCHAR* Name,
ERDGBufferFlags Flags
)

  
Public function void

ValidateRegisterExternalTexture ( FRDGTextureRef Texture
)

  
Public function void

ValidateRegisterExternalTexture ( const TRefCountPtr< IPooledRenderTarget >& ExternalPooledTexture,
const TCHAR* Name,
ERDGTextureFlags Flags
)

  
Public function void

ValidateSetAccessFinal ( FRDGViewableResource* Resource,
ERHIAccess AccessFinal
)

  
Public function void

ValidateUploadBuffer ( FRDGBufferRef Buffer,
const FRDGBufferInitialDataCallback& InitialDataCallback,
const FRDGBufferInitialDataSizeCallback& InitialDataSizeCallback
)

  
Public function void

ValidateUploadBuffer ( FRDGBufferRef Buffer,
const void* InitialData,
uint64 InitialDataSize
)

  
Public function void

ValidateUploadBuffer ( FRDGBufferRef Buffer,
const FRDGBufferInitialDataCallback& InitialDataCallback,
const FRDGBufferInitialDataSizeCallback& InitialDataSizeCallback,
const FRDGBufferInitialDataFreeCallback& InitialDataFreeCallback
)

  
Public function void

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

  
Public function void

ValidateUseExternalAccessMode ( FRDGViewableResource* Resource,
ERHIAccess ReadOnlyAccess,
ERHIPipeline Pipelines
)

  
Public function void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page