Navigation
API > API/Runtime > API/Runtime/Engine
| Name | FScreenshotRequest |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Public/UnrealClient.h |
| Include Path | #include "UnrealClient.h" |
Syntax
struct FScreenshotRequest
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| bIsScreenshotRequested | bool | UnrealClient.h | |
| bShowUI | bool | UnrealClient.h | |
| Filename | FString | UnrealClient.h | |
| HighresScreenshotMaskColorArray | TArray< FColor > | UnrealClient.h | |
| HighresScreenshotMaskExtents | FIntPoint | UnrealClient.h | |
| NextScreenshotName | FString | UnrealClient.h | |
| ScreenshotCapturedDelegate | FOnScreenshotCaptured | UnrealClient.h | |
| ScreenshotProcessedDelegate | FOnScreenshotRequestProcessed | UnrealClient.h | |
| ViewRect | FIntRect | UnrealClient.h |
Functions
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void CreateViewportScreenShotFilename
(
FString& InOutFilename |
Creates a new screenshot filename from the passed in filename template | UnrealClient.h | |
static const FString & GetFilename() |
UnrealClient.h | ||
| Access a temporary color array for storing the pixel colors for the highres screenshot mask | UnrealClient.h | ||
static FIntPoint & GetHighresScreenshotMaskExtents() |
Extents of array returned by function above | UnrealClient.h | |
static FIntRect GetViewRect() |
UnrealClient.h | ||
static bool IsScreenshotRequested() |
UnrealClient.h | ||
static FOnScreenshotCaptured & OnScreenshotCaptured() |
UnrealClient.h | ||
static FOnScreenshotRequestProcessed & OnScreenshotRequestProcessed() |
UnrealClient.h | ||
static void RequestScreenshot
(
bool bInShowUI |
Requests a new screenshot. | UnrealClient.h | |
static void RequestScreenshot
(
const FString& InFilename, |
Requests a new screenshot with a specific filename | UnrealClient.h | |
static void Reset() |
Resets a screenshot request | UnrealClient.h | |
static bool ShouldShowUI() |
UnrealClient.h |