HighResScreenshot.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
 
class FSceneViewport;
class IImageWrapper;
class UMaterial;
class FImageWriteTask;
class IImageWriteQueue;
 
DECLARE_LOG_CATEGORY_EXTERN(LogHighResScreenshot, Log, All);
 
struct FHighResScreenshotConfig
{
    static ENGINE_API const float MinResolutionMultipler;
    static ENGINE_API const float MaxResolutionMultipler;
 
    FIntRect UnscaledCaptureRegion;
    FIntRect CaptureRegion;
    float ResolutionMultiplier;
    float ResolutionMultiplierScale;
    bool bMaskEnabled;
    bool bDateTimeBasedNaming;
    bool bDumpBufferVisualizationTargets;
    TWeakPtr<FSceneViewport> TargetViewport;
    bool bDisplayCaptureRegion;
    bool bCaptureHDR;
    bool bForce128BitRendering;
    FString FilenameOverride;
 
    // Materials used in the editor to help with the capture of highres screenshots
    UMaterial* HighResScreenshotMaterial;
    UMaterial* HighResScreenshotMaskMaterial;
    UMaterial* HighResScreenshotCaptureRegionMaterial;
 
    IImageWriteQueue* ImageWriteQueue;
 
    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);
};
 
ENGINE_API FHighResScreenshotConfig& GetHighResScreenshotConfig();