UnrealEngineUWP/Engine/Source/Runtime/RenderCore/Public/RenderCaptureInterface.h

// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include "CoreMinimal.h"
#include "HAL/Platform.h"

class FRDGBuilder;
class FRHICommandListImmediate;

/** Easy to use interface for IRenderCaptureProvider. */
namespace RenderCaptureInterface
{
	/** 
	 * Helper for capturing within a scope. 
	 * Handles both game and render thread. Fails gracefully if no IRenderCaptureProvider exists.
	 */
	class FScopedCapture
	{
	public:
		/** Use this constructor if not on rendering thread. Use bEnable to allow control over the capture frequency. */
		RENDERCORE_API FScopedCapture(bool bEnable, TCHAR const* InEventName = nullptr, TCHAR const* InFileName = nullptr);
		/** Use this constructor if on rendering thread. Use bEnable to allow control over the capture frequency. */
		RENDERCORE_API FScopedCapture(bool bEnable, FRHICommandListImmediate* InRHICommandList, TCHAR const* InEventName = nullptr, TCHAR const* InFileName = nullptr);
		/** Use this constructor if using RenderGraph to schedule work. Use bEnable to allow control over the capture frequency. */
		RENDERCORE_API FScopedCapture(bool bEnable, FRDGBuilder& InGraphBuilder, TCHAR const* InEventName = nullptr, TCHAR const* InFileName = nullptr);

		RENDERCORE_API ~FScopedCapture();
	
	private:
		bool bCapture;
		bool bEvent;
		FRHICommandListImmediate* RHICommandList;
		FRDGBuilder* GraphBuilder;
	};
}