IRenderCaptureProvider.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Features/IModularFeatures.h"
 
class FRHICommandListImmediate;
class FViewport;
 
class IRenderCaptureProvider : public IModularFeature
{
public:
    static FName GetModularFeatureName()
    {
        static FName FeatureName = FName(TEXT("RenderCaptureProvider"));
        return FeatureName;
    }
 
    static inline bool IsAvailable()
    {
        // This function is accessible from the render and RHI threads, so lock the list of modular features before calling GetModularFeature
        IModularFeatures::FScopedLockModularFeatureList ScopedLockModularFeatureList;
        return IModularFeatures::Get().IsModularFeatureAvailable(GetModularFeatureName());
    }
 
    static inline IRenderCaptureProvider& Get()
    {
        // This function is accessible from the render and RHI threads, so lock the list of modular features before calling GetModularFeature
        IModularFeatures::FScopedLockModularFeatureList ScopedLockModularFeatureList;
        return IModularFeatures::Get().GetModularFeature<IRenderCaptureProvider>(GetModularFeatureName());
    }
 
    virtual bool CanSupportSubmissionThread() const { return true; }
 
    enum ECaptureFlags
    {
        // Set to launch the capture viewing application. Whether this is supported depends on the underlying capture tool.
        ECaptureFlags_Launch = 1, 
    };
 
    virtual void CaptureFrame(FViewport* InViewport = nullptr, uint32 InFlags = 0, FString const& InDestFileName = FString()) = 0;
 
    virtual void BeginCapture(FRHICommandListImmediate* InRHICommandList, uint32 InFlags = 0, FString const& InDestFileName = FString()) = 0;
    
    virtual void EndCapture(FRHICommandListImmediate* InRHICommandList) = 0;
};