Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. FHighResScreenshotConfig

FHighResScreenshotConfig

API > API/Runtime > API/Runtime/Engine

   
Name FHighResScreenshotConfig
Type struct
Header File /Engine/Source/Runtime/Engine/Public/HighResScreenshot.h
Include Path #include "HighResScreenshot.h"

Syntax

struct FHighResScreenshotConfig

Constructors

Name Remarks Include Path Unreal Specifiers

FHighResScreenshotConfig()

   HighResScreenshot.h  

Constants

Name Type Remarks Include Path
MaxResolutionMultipler const float   HighResScreenshot.h
MinResolutionMultipler const float   HighResScreenshot.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCaptureHDR bool   HighResScreenshot.h  
bDateTimeBasedNaming bool   HighResScreenshot.h  
bDisplayCaptureRegion bool   HighResScreenshot.h  
bDumpBufferVisualizationTargets bool   HighResScreenshot.h  
bForce128BitRendering bool   HighResScreenshot.h  
bMaskEnabled bool   HighResScreenshot.h  
CaptureRegion FIntRect   HighResScreenshot.h  
FilenameOverride FString   HighResScreenshot.h  
HighResScreenshotCaptureRegionMaterial UMaterial *   HighResScreenshot.h  
HighResScreenshotMaskMaterial UMaterial *   HighResScreenshot.h  
HighResScreenshotMaterial UMaterial * Materials used in the editor to help with the capture of highres screenshots. HighResScreenshot.h  
ImageWriteQueue IImageWriteQueue * Pointer to the image write queue to use for async image writes HighResScreenshot.h  
ResolutionMultiplier float   HighResScreenshot.h  
ResolutionMultiplierScale float   HighResScreenshot.h  
TargetViewport TWeakPtr< FSceneViewport >   HighResScreenshot.h  
UnscaledCaptureRegion FIntRect   HighResScreenshot.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ChangeViewport ( TWeakPtr< FSceneViewport > InViewport
)

 Point the screenshot UI at a different viewport HighResScreenshot.h  

void Init()

 Initialize the Image write queue necessary for asynchronously saving screenshots HighResScreenshot.h  

bool 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. HighResScreenshot.h  

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

   HighResScreenshot.h  

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

 Parse screenshot parameters from the supplied console command line HighResScreenshot.h  

void PopulateImageTaskParams ( FImageWriteTask& InOutTask
)

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

void SetFilename ( FString Filename
)

 Configure screenshot filename HighResScreenshot.h  

void SetForce128BitRendering ( bool bForce
)

 Enable/disable forcing 128-bit rendering pipeline for capture HighResScreenshot.h  

void SetHDRCapture ( bool bCaptureHDRIN
)

 Enable/disable HDR capable captures HighResScreenshot.h  

void SetMaskEnabled ( bool bShouldMaskBeEnabled
)

 Configure screenshot mask is enabled HighResScreenshot.h  

bool SetResolution ( uint32 ResolutionX,
uint32 ResolutionY,
float ResolutionScale
)

 Configure taking a high res screenshot HighResScreenshot.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page