IRenderCaptureProvider

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IModularFeature

IRenderCaptureProvider

IPixWinPlugin

References

Module

RenderCore

Header

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

Include

#include "IRenderCaptureProvider.h"

Syntax

class IRenderCaptureProvider : public IModularFeature

Functions

Name Description

Public function

void

 

BeginCapture

(
    FRHICommandListImmediate* InRH...,
    uint32 InFlags,
    FString const& InDestFileName
)

Start capturing rendering information. Call from render thread only.

Public function

void

 

CaptureFrame

(
    FViewport* InViewport,
    uint32 InFlags,
    FString const& InDestFileName
)

Capture the next full frame of rendering information.

Public function

void

 

EndCapture

(
    FRHICommandListImmediate* InRH...
)

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

Public function Static

IRenderCaptu...

 

Get()

Gets the first registered implementation of this feature.

Public function Static

FName

 

GetModularFeatureName()

Get the feature name used for module resolution.

Public function Static

bool

 

IsAvailable()

Checks to see if the specified feature is available.

Enums

Name

Description

Public enum

ECaptureFlags

Flags to pass to capture API.