UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UnrealClient.h File Reference

Go to the source code of this file.

Classes

class  FRenderTarget
 
class  FViewportFrame
 
struct  FScreenshotRequest
 
struct  FStatUnitData
 
struct  FStatHitchesData
 
class  FViewport
 
class  FViewport::FHitProxyMap
 

Macros

#define MAX_HITPROXYSIZE   200
 

Functions

 DECLARE_MULTICAST_DELEGATE (FOnScreenshotRequestProcessed)
 
 DECLARE_MULTICAST_DELEGATE_ThreeParams (FOnScreenshotCaptured, int32, int32, const TArray< FColor > &)
 
ENGINE_API FString GetMemoryString (const double Value, const bool bAutoType=true)
 
ENGINE_API bool IsCtrlDown (FViewport *Viewport)
 
ENGINE_API bool IsShiftDown (FViewport *Viewport)
 
ENGINE_API bool IsAltDown (FViewport *Viewport)
 
ENGINE_API bool GetViewportScreenShot (FViewport *Viewport, TArray< FColor > &Bitmap, const FIntRect &ViewRect=FIntRect(), const FReadSurfaceDataFlags &ReadSurfaceFlags=FReadSurfaceDataFlags())
 
ENGINE_API bool GetViewportScreenShotHDR (FViewport *Viewport, TArray< FLinearColor > &Bitmap, const FIntRect &ViewRect=FIntRect(), const FReadSurfaceDataFlags &ReadSurfaceFlags=FReadSurfaceDataFlags(RCM_MinMax))
 
ENGINE_API bool GetHighResScreenShotInput (const TCHAR *Cmd, FOutputDevice &Ar, uint32 &OutXRes, uint32 &OutYRes, float &OutResMult, FIntRect &OutCaptureRegion, bool &OutShouldEnableMask, bool &OutDumpBufferVisualizationTargets, bool &OutCaptureHDR, FString &OutFilenameOverride, bool &OutUseDateTimeAsFileName)
 

Variables

ENGINE_API class FCommonViewportClientGStatProcessingViewportClient
 

Macro Definition Documentation

◆ MAX_HITPROXYSIZE

#define MAX_HITPROXYSIZE   200

The maximum size that the hit proxy kernel is allowed to be set to

Function Documentation

◆ DECLARE_MULTICAST_DELEGATE()

DECLARE_MULTICAST_DELEGATE ( FOnScreenshotRequestProcessed  )

◆ DECLARE_MULTICAST_DELEGATE_ThreeParams()

DECLARE_MULTICAST_DELEGATE_ThreeParams ( FOnScreenshotCaptured  ,
int32  ,
int32  ,
const TArray< FColor > &   
)

◆ GetHighResScreenShotInput()

ENGINE_API bool GetHighResScreenShotInput ( const TCHAR Cmd,
FOutputDevice Ar,
uint32 OutXRes,
uint32 OutYRes,
float OutResMult,
FIntRect OutCaptureRegion,
bool OutShouldEnableMask,
bool OutDumpBufferVisualizationTargets,
bool OutCaptureHDR,
FString &  OutFilenameOverride,
bool OutUseDateTimeAsFileName 
)
extern

◆ GetMemoryString()

ENGINE_API FString GetMemoryString ( const double  Value,
const bool  bAutoType = true 
)

◆ GetViewportScreenShot()

ENGINE_API bool GetViewportScreenShot ( FViewport Viewport,
TArray< FColor > &  Bitmap,
const FIntRect ViewRect = FIntRect(),
const FReadSurfaceDataFlags ReadSurfaceFlags = FReadSurfaceDataFlags() 
)
extern

◆ GetViewportScreenShotHDR()

ENGINE_API bool GetViewportScreenShotHDR ( FViewport Viewport,
TArray< FLinearColor > &  Bitmap,
const FIntRect ViewRect = FIntRect(),
const FReadSurfaceDataFlags ReadSurfaceFlags = FReadSurfaceDataFlags(RCM_MinMax) 
)
extern

◆ IsAltDown()

ENGINE_API bool IsAltDown ( FViewport Viewport)
extern

◆ IsCtrlDown()

ENGINE_API bool IsCtrlDown ( FViewport Viewport)
extern

◆ IsShiftDown()

ENGINE_API bool IsShiftDown ( FViewport Viewport)
extern

Variable Documentation

◆ GStatProcessingViewportClient

ENGINE_API class FCommonViewportClient* GStatProcessingViewportClient
extern

Tracks the viewport client that should process the stat command, can be NULL