Navigation
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 | |
|---|---|---|---|
| bool | bCaptureHDR | ||
| bool | bDateTimeBasedNaming | ||
| bool | bDisplayCaptureRegion | ||
| bool | bDumpBufferVisualizationTargets | ||
| bool | bForce128BitRendering | ||
| bool | bMaskEnabled | ||
| FIntRect | CaptureRegion | ||
| FString | FilenameOverride | ||
| UMaterial * | HighResScreenshotCaptureRegionMaterial | ||
| UMaterial * | HighResScreenshotMaskMaterial | ||
| UMaterial * | HighResScreenshotMaterial | Materials used in the editor to help with the capture of highres screenshots. | |
| IImageWriteQueue * | ImageWriteQueue | Pointer to the image write queue to use for async image writes | |
| float | ResolutionMultiplier | ||
| float | ResolutionMultiplierScale | ||
| TWeakPtr< FSceneViewport > | TargetViewport | ||
| FIntRect | UnscaledCaptureRegion |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | ChangeViewport
(
TWeakPtr< FSceneViewport > InViewport |
Point the screenshot UI at a different viewport | |
| void | Init () |
Initialize the Image write queue necessary for asynchronously saving screenshots | |
| bool | MergeMaskIntoAlpha
(
TArray< FColor >& InBitmap, |
Utility function for merging the mask buffer into the alpha channel of the supplied bitmap, if masking is enabled. | |
| bool | MergeMaskIntoAlpha
(
TArray< FLinearColor >& InBitmap, |
Utility function for merging the mask buffer into the alpha channel of the supplied bitmap, if masking is enabled. | |
| bool | ParseConsoleCommand
(
const FString& InCmd, |
Parse screenshot parameters from the supplied console command line | |
| void | PopulateImageTaskParams
(
FImageWriteTask& InOutTask |
Populate the specified task with parameters from the current high-res screenshot request | |
| void | SetFilename
(
FString Filename |
Configure screenshot filename | |
| void | SetForce128BitRendering
(
bool bForce |
Enable/disable forcing 128-bit rendering pipeline for capture | |
| void | SetHDRCapture
(
bool bCaptureHDRIN |
Enable/disable HDR capable captures | |
| void | SetMaskEnabled
(
bool bShouldMaskBeEnabled |
Configure screenshot mask is enabled | |
| bool | SetResolution
(
uint32 ResolutionX, |
Configure taking a high res screenshot |
Constants
| Name | Description |
|---|---|
| MaxResolutionMultipler | |
| MinResolutionMultipler |