FHighResScreenshotConfig

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/HighResScreenshot.h

Include

#include "HighResScreenshot.h"

Syntax

struct FHighResScreenshotConfig

Variables

Name Description

Public variable

bool

 

bCaptureHDR

Public variable

bool

 

bDisplayCaptureRegion

Public variable

bool

 

bDumpBufferVisualizationTargets

Public variable

bool

 

bForce128BitRendering

Public variable

bool

 

bMaskEnabled

Public variable

FIntRect

 

CaptureRegion

Public variable

FString

 

FilenameOverride

Public variable

UMaterial *

 

HighResScreenshotCaptureRegionMaterial

Public variable

UMaterial *

 

HighResScreenshotMaskMaterial

Public variable

UMaterial *

 

HighResScreenshotMaterial

Materials used in the editor to help with the capture of highres screenshots.

Public variable

IImageWriteQueu...

 

ImageWriteQueue

Pointer to the image write queue to use for async image writes

Public variable

float

 

ResolutionMultiplier

Public variable

float

 

ResolutionMultiplierScale

Public variable

TWeakPtr< FScen...

 

TargetViewport

Public variable

FIntRect

 

UnscaledCaptureRegion

Constructors

Name Description

Public function

FHighResScreenshotConfig()

Functions

Name Description

Public function

void

 

ChangeViewport

(
    TWeakPtr< FSceneViewport > InViewpo...
)

Point the screenshot UI at a different viewport

Public function

void

 

Init()

Initialize the Image write queue necessary for asynchronously saving screenshots

Public function

bool

 

MergeMaskIntoAlpha

(
    TArray< FColor >& InBitmap
)

Utility function for merging the mask buffer into the alpha channel of the supplied bitmap, if masking is enabled.

Public function

bool

 

ParseConsoleCommand

(
    const FString& InCmd,
    FOutputDevice& Ar
)

Parse screenshot parameters from the supplied console command line

Public function

void

 

PopulateImageTaskParams

(
    FImageWriteTask& InOutTask
)

Populate the specified task with parameters from the current high-res screenshot request

Public function

void

 

SetFilename

(
    FString Filename
)

Configure screenshot filename

Public function

void

 

SetForce128BitRendering

(
    bool bForce
)

Enable/disable forcing 128-bit rendering pipeline for capture

Public function

void

 

SetHDRCapture

(
    bool bCaptureHDRIN
)

Enable/disable HDR capable captures

Public function

void

 

SetMaskEnabled

(
    bool bShouldMaskBeEnabled
)

Configure screenshot mask is enabled

Public function

bool

 

SetResolution

(
    uint32 ResolutionX,
    uint32 ResolutionY,
    float ResolutionScale
)

Configure taking a high res screenshot

Constants

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback