Module |
|
Header |
/Engine/Source/Runtime/RenderCore/Public/RenderGraphValidation.h |
Include |
#include "RenderGraphValidation.h" |
class FRDGUserValidation
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.
Name | Description | |
---|---|---|
|
FRDGUserValidation() |
|
|
FRDGUserValidation ( |
Name | Description | |
---|---|---|
|
~FRDGUserValidation() |
Name | Description | ||
---|---|---|---|
|
ExecuteGuard |
Validates that the graph has not executed yet. |
|
|
RemoveUnusedWarning ( |
Removes the 'produced but not used' warning from the requested resource. |
|
|
ValidateAddPass |
Tracks and validates the addition of a new pass to the graph. |
|
|
ValidateAllocPassParameters ( |
Tracks and validates usage of a pass parameters allocation. |
|
|
ValidateCreateBuffer ( |
||
|
ValidateCreateExternalBuffer ( |
||
|
ValidateCreateExternalTexture ( |
Tracks and validates the creation of a new externally registered resource. |
|
|
ValidateCreateTexture ( |
Tracks and validates the creation of a new resource in the graph. |
|
|
ValidateExecuteBegin() |
Validate graph state before and after execution. |
|
|
ValidateExecuteEnd() |
||
|
ValidateExecutePassBegin ( |
Validate pass state before and after execution. |
|
|
ValidateExecutePassEnd ( |
||
|
ValidateExtractResource ( |
Validates a resource extraction operation. |