IRenderCaptureProvider Class Reference

#include <IRenderCaptureProvider.h>

Inheritance diagram for IRenderCaptureProvider:

Public Types
enum	ECaptureFlags { ECaptureFlags_Launch = 1 }

Public Member Functions
virtual bool	CanSupportSubmissionThread () const
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

Static Public Member Functions
static FName	GetModularFeatureName ()
static bool	IsAvailable ()
static IRenderCaptureProvider &	Get ()

Member Enumeration Documentation

ECaptureFlags

enum IRenderCaptureProvider::ECaptureFlags

Flags to pass to capture API.

Enumerator
ECaptureFlags_Launch

Member Function Documentation

BeginCapture()

virtual void IRenderCaptureProvider::BeginCapture ( FRHICommandListImmediate *  InRHICommandList, uint32  InFlags = 0, FString const &  InDestFileName = FString()  )

pure virtual

Start capturing rendering information. Call from render thread only.

Parameters

RHICommandList	The command list to capture on.
DestFileName	The destination file name for saving the capture. (Optional).

CanSupportSubmissionThread()

virtual bool IRenderCaptureProvider::CanSupportSubmissionThread ( ) const

inlinevirtual

Derived classes return false if they cannot support an RHI submission thread.

CaptureFrame()

virtual void IRenderCaptureProvider::CaptureFrame ( FViewport *  InViewport = nullptr, uint32  InFlags = 0, FString const &  InDestFileName = FString()  )

pure virtual

Capture the next full frame of rendering information. Currently any capture details (number of frames etc.) must be set up by CVars exposed in the underlying capture tool. Call from main thread only.

Parameters

Viewport	The specific viewport to capture. (Optional).
bLaunch
DestFileName	The destination file name for saving the capture. (Optional).

EndCapture()

virtual void IRenderCaptureProvider::EndCapture ( FRHICommandListImmediate *  InRHICommandList )

pure virtual

Stop capturing rendering information and save the captured data. Call from render thread only.

Parameters

RHICommandList

The command list to capture on.

Get()

static IRenderCaptureProvider & IRenderCaptureProvider::Get ( )

inlinestatic

Gets the first registered implementation of this feature. Will assert or crash if the specified feature is not available! You should call IsAvailable() first!

Returns

The feature.

GetModularFeatureName()

static FName IRenderCaptureProvider::GetModularFeatureName ( )

inlinestatic

Get the feature name used for module resolution.

Returns

The feature name.

IsAvailable()

static bool IRenderCaptureProvider::IsAvailable ( )

inlinestatic

Checks to see if the specified feature is available.

Returns

True if the feature is available right now and it is safe to call Get().

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/RenderCore/Public/IRenderCaptureProvider.h