UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Static Public Member Functions | List of all members
FScreenshotRequest Struct Reference

#include <UnrealClient.h>

Static Public Member Functions

static ENGINE_API void RequestScreenshot (bool bInShowUI)
 
static ENGINE_API void RequestScreenshot (const FString &InFilename, bool bInShowUI, bool bAddFilenameSuffix, bool bHdrScreenshot=false, const FIntRect &InViewRect=FIntRect())
 
static ENGINE_API void Reset ()
 
static const FString & GetFilename ()
 
static bool IsScreenshotRequested ()
 
static bool ShouldShowUI ()
 
static FIntRect GetViewRect ()
 
static ENGINE_API void CreateViewportScreenShotFilename (FString &InOutFilename)
 
static ENGINE_API TArray< FColor > * GetHighresScreenshotMaskColorArray ()
 
static ENGINE_API FIntPoint & GetHighresScreenshotMaskExtents ()
 
static FOnScreenshotRequestProcessed & OnScreenshotRequestProcessed ()
 
static FOnScreenshotCaptured & OnScreenshotCaptured ()
 

Member Function Documentation

◆ CreateViewportScreenShotFilename()

void FScreenshotRequest::CreateViewportScreenShotFilename ( FString &  InOutFilename)
static

Creates a new screenshot filename from the passed in filename template

◆ GetFilename()

static const FString & FScreenshotRequest::GetFilename ( )
inlinestatic
Returns
The filename of the next screenshot

◆ GetHighresScreenshotMaskColorArray()

TArray< FColor > * FScreenshotRequest::GetHighresScreenshotMaskColorArray ( )
static

Access a temporary color array for storing the pixel colors for the highres screenshot mask

◆ GetHighresScreenshotMaskExtents()

FIntPoint & FScreenshotRequest::GetHighresScreenshotMaskExtents ( )
static

Extents of array returned by function above

◆ GetViewRect()

static FIntRect FScreenshotRequest::GetViewRect ( )
inlinestatic
Returns
The view rect for the next screenshot

◆ IsScreenshotRequested()

static bool FScreenshotRequest::IsScreenshotRequested ( )
inlinestatic
Returns
True if a screenshot is requested

◆ OnScreenshotCaptured()

static FOnScreenshotCaptured & FScreenshotRequest::OnScreenshotCaptured ( )
inlinestatic

◆ OnScreenshotRequestProcessed()

static FOnScreenshotRequestProcessed & FScreenshotRequest::OnScreenshotRequestProcessed ( )
inlinestatic

◆ RequestScreenshot() [1/2]

void FScreenshotRequest::RequestScreenshot ( bool  bInShowUI)
static

Requests a new screenshot. Screenshot can be read from memory by subscribing to the ViewPort's OnScreenshotCaptured delegate.

Parameters
bInShowUIWhether or not to show Slate UI

◆ RequestScreenshot() [2/2]

void FScreenshotRequest::RequestScreenshot ( const FString &  InFilename,
bool  bInShowUI,
bool  bAddFilenameSuffix,
bool  bHdrScreenshot = false,
const FIntRect &  InViewRect = FIntRect() 
)
static

Requests a new screenshot with a specific filename

Parameters
InFilenameThe filename to use
bInShowUIWhether or not to show Slate UI
bAddFilenameSuffixWhether an auto-generated unique suffix should be added to the supplied filename
bHdrScreenshotIf true, the screenshot is saved as .exr rather than .png
InViewRectIf non-empty, within the viewport extent, and bInShowUI=false, only this view rect will be included in the screenshot

◆ Reset()

void FScreenshotRequest::Reset ( )
static

Resets a screenshot request

◆ ShouldShowUI()

static bool FScreenshotRequest::ShouldShowUI ( )
inlinestatic
Returns
True if UI should be shown in the screenshot
The documentation for this struct was generated from the following files: