1. Epic GamesDeveloper
  3. FHighResScreenshotConfig

FHighResScreenshotConfig

API > API/Runtime > API/Runtime/Engine

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/HighResScreenshot.h
Include #include "HighResScreenshot.h"

Syntax

struct FHighResScreenshotConfig

Variables

  Type Name Description
Public variable bool bCaptureHDR  
Public variable bool bDateTimeBasedNaming  
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 IImageWriteQueue * ImageWriteQueue Pointer to the image write queue to use for async image writes
Public variable float ResolutionMultiplier  
Public variable float ResolutionMultiplierScale  
Public variable TWeakPtr< FSceneViewport > TargetViewport  
Public variable FIntRect UnscaledCaptureRegion  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void 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,
const FIntRect& ViewRect
)

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

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

 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 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

Name Description
MaxResolutionMultipler  
MinResolutionMultipler  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page