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

Classes

struct  FEndDrawingCommandParams
 

Macros

#define STATUNIT_FORMAT_AVGTIME   TEXT("%3.2f ms")
 
#define STATUNIT_FORMAT_CRITICALPATHTIME   TEXT("%3.2f ms")
 
#define STATUNIT_FORMAT_MAXTIME   TEXT("%4.2f ms")
 
#define STATUNIT_FORMAT_PERCEMT   TEXT("%3.2f %%")
 

Functions

 DEFINE_LOG_CATEGORY_STATIC (LogClient, Log, All)
 
 UE_IMPLEMENT_STRUCT ("/Script/Engine", PostProcessSettings)
 
FString GetMemoryString (const double Value, const bool bAutoType)
 
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, const FReadSurfaceDataFlags &ReadSurfaceFlags)
 
ENGINE_API bool GetViewportScreenShotHDR (FViewport *Viewport, TArray< FLinearColor > &Bitmap, const FIntRect &ViewRect, const FReadSurfaceDataFlags &ReadSurfaceFlags)
 
bool ParseResolution (const TCHAR *InResolution, uint32 &OutX, uint32 &OutY, int32 &WindowMode)
 
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

FCommonViewportClientGStatProcessingViewportClient = NULL
 

Macro Definition Documentation

◆ STATUNIT_FORMAT_AVGTIME

#define STATUNIT_FORMAT_AVGTIME   TEXT("%3.2f ms")

◆ STATUNIT_FORMAT_CRITICALPATHTIME

#define STATUNIT_FORMAT_CRITICALPATHTIME   TEXT("%3.2f ms")

◆ STATUNIT_FORMAT_MAXTIME

#define STATUNIT_FORMAT_MAXTIME   TEXT("%4.2f ms")

◆ STATUNIT_FORMAT_PERCEMT

#define STATUNIT_FORMAT_PERCEMT   TEXT("%3.2f %%")

Function Documentation

◆ DEFINE_LOG_CATEGORY_STATIC()

DEFINE_LOG_CATEGORY_STATIC ( LogClient  ,
Log  ,
All   
)

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

◆ GetMemoryString()

FString GetMemoryString ( const double  Value,
const bool  bAutoType 
)

◆ GetViewportScreenShot()

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

◆ GetViewportScreenShotHDR()

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

◆ IsAltDown()

ENGINE_API bool IsAltDown ( FViewport Viewport)

◆ IsCtrlDown()

ENGINE_API bool IsCtrlDown ( FViewport Viewport)

◆ IsShiftDown()

ENGINE_API bool IsShiftDown ( FViewport Viewport)

◆ ParseResolution()

bool ParseResolution ( const TCHAR InResolution,
uint32 OutX,
uint32 OutY,
int32 WindowMode 
)
extern

◆ UE_IMPLEMENT_STRUCT()

UE_IMPLEMENT_STRUCT ( "/Script/Engine"  ,
PostProcessSettings   
)

Variable Documentation

◆ GStatProcessingViewportClient

FCommonViewportClient* GStatProcessingViewportClient = NULL

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