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

Go to the source code of this file.

Functions

 DECLARE_MULTICAST_DELEGATE_ThreeParams (FOnScreenshotCaptured, int32, int32, const TArray< FColor > &)
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FOnViewportRendered, FViewport *)
 
 DECLARE_DELEGATE_RetVal (bool, FOnWindowCloseRequested)
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FOnCloseRequested, FViewport *)
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FOnGameViewportClientPlayerAction, int32)
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FOnGameViewportTick, float)
 
 DECLARE_DELEGATE_RetVal_ThreeParams (bool, FOnGameViewportInputKey, FKey, FModifierKeysState, EInputEvent)
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FOnToggleFullscreen, bool)
 

Function Documentation

◆ DECLARE_DELEGATE_RetVal()

DECLARE_DELEGATE_RetVal ( bool  ,
FOnWindowCloseRequested   
)

Delegate type used by UGameViewportClient when the top level window associated with the viewport has been requested to close. At this point, the viewport has not been closed and the operation may be canceled. This may not called from PIE, Editor Windows, on consoles, or before the game ends from other methods. This is only when the platform specific window is closed.

Return indicates whether or not the window may be closed.

See also
UGameViewportClient.

◆ DECLARE_DELEGATE_RetVal_ThreeParams()

DECLARE_DELEGATE_RetVal_ThreeParams ( bool  ,
FOnGameViewportInputKey  ,
FKey  ,
FModifierKeysState  ,
EInputEvent   
)

◆ DECLARE_MULTICAST_DELEGATE_OneParam() [1/5]

DECLARE_MULTICAST_DELEGATE_OneParam ( FOnCloseRequested  ,
FViewport  
)

Delegate type used by UGameViewportClient when call is made to close a viewport

The first parameter is the viewport being closed.

See also
UGameViewportClient

◆ DECLARE_MULTICAST_DELEGATE_OneParam() [2/5]

DECLARE_MULTICAST_DELEGATE_OneParam ( FOnGameViewportClientPlayerAction  ,
int32   
)

Delegate type used by UGameViewportClient for when a player is added or removed

The first parameter is the player index

See also
UGameViewportClient

◆ DECLARE_MULTICAST_DELEGATE_OneParam() [3/5]

DECLARE_MULTICAST_DELEGATE_OneParam ( FOnGameViewportTick  ,
float   
)

Delegate type used by UGameViewportClient for tick callbacks

The first parameter is the time delta

See also
UGameViewportClient

◆ DECLARE_MULTICAST_DELEGATE_OneParam() [4/5]

DECLARE_MULTICAST_DELEGATE_OneParam ( FOnToggleFullscreen  ,
bool   
)

Delegate type used by UGameViewportClient for when engine in toggling fullscreen

See also
UGameViewportClient

◆ DECLARE_MULTICAST_DELEGATE_OneParam() [5/5]

DECLARE_MULTICAST_DELEGATE_OneParam ( FOnViewportRendered  ,
FViewport  
)

Delegate type used by UGameViewportClient when a viewport is rendered

The first parameter is the viewport.

See also
UGameViewportClient

◆ DECLARE_MULTICAST_DELEGATE_ThreeParams()

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

Delegate type used by UGameViewportClient when a screenshot has been captured

The first parameter is the width. The second parameter is the height. The third parameter is the array of bitmap data.

See also
UGameViewportClient