RenderCaptureInterface.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "RenderGraphEvent.h"
#include "RHIBreadcrumbs.h"
 
class FRDGBuilder;
class FRHICommandList;
 
namespace RenderCaptureInterface
{
    class FScopedCapture
    {
    public:
        RENDERCORE_API FScopedCapture(bool bEnable, TCHAR const* InEventName = nullptr, TCHAR const* InFileName = nullptr);
        RENDERCORE_API FScopedCapture(bool bEnable, FRHICommandList* InRHICommandList, TCHAR const* InEventName = nullptr, TCHAR const* InFileName = nullptr);
        RENDERCORE_API FScopedCapture(bool bEnable, FRDGBuilder& InGraphBuilder, TCHAR const* InEventName = nullptr, TCHAR const* InFileName = nullptr);
 
        RENDERCORE_API ~FScopedCapture();
    
    private:
        bool bCapture;
        bool bEvent;
        FRHICommandList* RHICommandList;
        FRDGBuilder* GraphBuilder;
#if RDG_EVENTS
        TOptional<TRDGEventScopeGuard<FRDGScope_RHI>> RDGEvent;
#endif
#if WITH_RHI_BREADCRUMBS
        TUniquePtr<TOptional<FRHIBreadcrumbEventManual>> RHIBreadcrumb;
#endif
    };
}