#include <HighResScreenshot.h>

Public Member Functions
ENGINE_API	FHighResScreenshotConfig ()

ENGINE_API void	Init ()

ENGINE_API void	PopulateImageTaskParams (FImageWriteTask &InOutTask)

ENGINE_API void	ChangeViewport (TWeakPtr< FSceneViewport > InViewport)

ENGINE_API bool	ParseConsoleCommand (const FString &InCmd, FOutputDevice &Ar)

ENGINE_API bool	MergeMaskIntoAlpha (TArray< FColor > &InBitmap, const FIntRect &ViewRect)

ENGINE_API bool	MergeMaskIntoAlpha (TArray< FLinearColor > &InBitmap, const FIntRect &ViewRect)

ENGINE_API void	SetHDRCapture (bool bCaptureHDRIN)

ENGINE_API void	SetForce128BitRendering (bool bForce)

ENGINE_API bool	SetResolution (uint32 ResolutionX, uint32 ResolutionY, float ResolutionScale=1.0f)

ENGINE_API void	SetFilename (FString Filename)

ENGINE_API void	SetMaskEnabled (bool bShouldMaskBeEnabled)

Static Public Attributes
static ENGINE_API const float	MinResolutionMultipler = 1.0f

static ENGINE_API const float	MaxResolutionMultipler = 10.0f

Constructor & Destructor Documentation

◆ FHighResScreenshotConfig()

FHighResScreenshotConfig::FHighResScreenshotConfig ( )

Member Function Documentation

◆ ChangeViewport()

void FHighResScreenshotConfig::ChangeViewport ( TWeakPtr< FSceneViewport > InViewport )

Point the screenshot UI at a different viewport

◆ Init()

void FHighResScreenshotConfig::Init ( )

Initialize the Image write queue necessary for asynchronously saving screenshots

◆ MergeMaskIntoAlpha() [1/2]

bool FHighResScreenshotConfig::MergeMaskIntoAlpha	(	TArray< FColor > &	InBitmap,
		const FIntRect &	ViewRect
	)

Utility function for merging the mask buffer into the alpha channel of the supplied bitmap, if masking is enabled. Returns true if the mask was written, and false otherwise.

◆ MergeMaskIntoAlpha() [2/2]

bool FHighResScreenshotConfig::MergeMaskIntoAlpha	(	TArray< FLinearColor > &	InBitmap,
		const FIntRect &	ViewRect
	)

◆ ParseConsoleCommand()

bool FHighResScreenshotConfig::ParseConsoleCommand	(	const FString &	InCmd,
		FOutputDevice &	Ar
	)

Parse screenshot parameters from the supplied console command line

◆ PopulateImageTaskParams()

void FHighResScreenshotConfig::PopulateImageTaskParams ( FImageWriteTask & InOutTask )

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

◆ SetFilename()

void FHighResScreenshotConfig::SetFilename ( FString Filename )

Configure screenshot filename

◆ SetForce128BitRendering()

void FHighResScreenshotConfig::SetForce128BitRendering ( bool bForce )

Enable/disable forcing 128-bit rendering pipeline for capture

◆ SetHDRCapture()

void FHighResScreenshotConfig::SetHDRCapture ( bool bCaptureHDRIN )

Enable/disable HDR capable captures

◆ SetMaskEnabled()

void FHighResScreenshotConfig::SetMaskEnabled ( bool bShouldMaskBeEnabled )

Configure screenshot mask is enabled

◆ SetResolution()

bool FHighResScreenshotConfig::SetResolution	(	uint32	ResolutionX,
		uint32	ResolutionY,
		float	ResolutionScale = `1.0f`
	)

Configure taking a high res screenshot

Member Data Documentation

◆ bCaptureHDR

bool FHighResScreenshotConfig::bCaptureHDR

◆ bDateTimeBasedNaming

bool FHighResScreenshotConfig::bDateTimeBasedNaming

◆ bDisplayCaptureRegion

bool FHighResScreenshotConfig::bDisplayCaptureRegion

◆ bDumpBufferVisualizationTargets

bool FHighResScreenshotConfig::bDumpBufferVisualizationTargets

◆ bForce128BitRendering

bool FHighResScreenshotConfig::bForce128BitRendering

◆ bMaskEnabled

bool FHighResScreenshotConfig::bMaskEnabled

◆ CaptureRegion

FIntRect FHighResScreenshotConfig::CaptureRegion

◆ FilenameOverride

FString FHighResScreenshotConfig::FilenameOverride

◆ HighResScreenshotCaptureRegionMaterial

UMaterial* FHighResScreenshotConfig::HighResScreenshotCaptureRegionMaterial

◆ HighResScreenshotMaskMaterial

UMaterial* FHighResScreenshotConfig::HighResScreenshotMaskMaterial

◆ HighResScreenshotMaterial

UMaterial* FHighResScreenshotConfig::HighResScreenshotMaterial

◆ ImageWriteQueue

IImageWriteQueue* FHighResScreenshotConfig::ImageWriteQueue

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

◆ MaxResolutionMultipler

const float FHighResScreenshotConfig::MaxResolutionMultipler = 10.0f

static

◆ MinResolutionMultipler

const float FHighResScreenshotConfig::MinResolutionMultipler = 1.0f