UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | List of all members
FCommonViewportClient Class Reference

#include <ViewportClient.h>

+ Inheritance diagram for FCommonViewportClient:

Public Member Functions

 FCommonViewportClient ()
 
virtual ENGINE_API ~FCommonViewportClient () override
 
ENGINE_API void RequestUpdateDPIScale ()
 
ENGINE_API float GetDPIDerivedResolutionFraction () const
 
virtual ENGINE_API float GetDPIScale () const override
 
ENGINE_API void DrawHighResScreenshotCaptureRegion (FCanvas &Canvas)
 
- Public Member Functions inherited from FViewportClient
virtual ~FViewportClient ()
 
virtual void Precache ()
 
virtual ENGINE_API void RedrawRequested (FViewport *Viewport)
 
virtual ENGINE_API void RequestInvalidateHitProxy (FViewport *Viewport)
 
virtual void Draw (FViewport *Viewport, FCanvas *Canvas)
 
virtual bool ProcessScreenShots (FViewport *Viewport)
 
virtual UWorld * GetWorld () const
 
virtual struct FEngineShowFlags * GetEngineShowFlags ()
 
virtual bool InputKey (const FInputKeyEventArgs &EventArgs)
 
virtual ENGINE_API bool InputAxis (FViewport *Viewport, FInputDeviceId InputDevice, FKey Key, float Delta, float DeltaTime, int32 NumSamples=1, bool bGamepad=false) final
 
virtual bool InputAxis (const FInputKeyEventArgs &Args)
 
virtual bool InputChar (FViewport *Viewport, int32 ControllerId, TCHAR Character)
 
virtual ENGINE_API bool InputTouch (FViewport *Viewport, int32 ControllerId, uint32 Handle, ETouchType::Type Type, const FVector2D &TouchLocation, float Force, FDateTime DeviceTimestamp, uint32 TouchpadIndex) final
 
virtual bool InputTouch (FViewport *Viewport, const FInputDeviceId DeviceId, uint32 Handle, ETouchType::Type Type, const FVector2D &TouchLocation, float Force, uint32 TouchpadIndex, const uint64 Timestamp)
 
virtual ENGINE_API bool InputGesture (FViewport *Viewport, EGestureEvent GestureType, const FVector2D &GestureDelta, bool bIsDirectionInvertedFromDevice) final
 
virtual bool InputGesture (FViewport *Viewport, const FInputDeviceId DeviceId, EGestureEvent GestureType, const FVector2D &GestureDelta, bool bIsDirectionInvertedFromDevice, const uint64 Timestamp)
 
virtual ENGINE_API bool InputMotion (FViewport *Viewport, int32 ControllerId, const FVector &Tilt, const FVector &RotationRate, const FVector &Gravity, const FVector &Acceleration) final
 
virtual bool InputMotion (FViewport *Viewport, const FInputDeviceId DeviceId, const FVector &Tilt, const FVector &RotationRate, const FVector &Gravity, const FVector &Acceleration, const uint64 Timestamp)
 
virtual void SetIsSimulateInEditorViewport (bool bInIsSimulateInEditorViewport)
 
virtual bool WantsPollingMouseMovement (void) const
 
virtual void MouseEnter (FViewport *Viewport, int32 x, int32 y)
 
virtual void MouseLeave (FViewport *Viewport)
 
virtual void MouseMove (FViewport *Viewport, int32 X, int32 Y)
 
virtual void CapturedMouseMove (FViewport *InViewport, int32 InMouseX, int32 InMouseY)
 
virtual void ProcessAccumulatedPointerInput (FViewport *InViewport)
 
virtual EMouseCursor::Type GetCursor (FViewport *Viewport, int32 X, int32 Y)
 
virtual ENGINE_API TOptional< TSharedRef< SWidget > > MapCursor (FViewport *Viewport, const FCursorReply &CursorReply)
 
virtual TOptional< bool > QueryShowFocus (const EFocusCause InFocusCause) const
 
virtual void LostFocus (FViewport *Viewport)
 
virtual void ReceivedFocus (FViewport *Viewport)
 
virtual bool IsFocused (FViewport *Viewport)
 
virtual void Activated (FViewport *Viewport, const FWindowActivateEvent &InActivateEvent)
 
virtual void Deactivated (FViewport *Viewport, const FWindowActivateEvent &InActivateEvent)
 
virtual bool IsInPermanentCapture ()
 
virtual bool WindowCloseRequested ()
 
virtual void CloseRequested (FViewport *Viewport)
 
virtual bool RequiresHitProxyStorage ()
 
virtual bool RequiresUncapturedAxisInput () const
 
virtual bool RequiresKeyboardInput () const
 
virtual bool IsOrtho () const
 
virtual bool IsInGameView () const
 
virtual class UWorld * ConditionalSetWorld ()
 
virtual void ConditionalRestoreWorld (class UWorld *InWorld)
 
virtual bool OverrideHighResScreenshotCaptureRegion (FIntRect &OutCaptureRegion)
 
virtual FStatUnitData * GetStatUnitData () const
 
virtual FStatHitchesData * GetStatHitchesData () const
 
virtual const TArray< FString > * GetEnabledStats () const
 
virtual void SetEnabledStats (const TArray< FString > &InEnabledStats)
 
virtual bool IsStatEnabled (const FString &InName) const
 
virtual void SetShowStats (bool bWantStats)
 
virtual bool IgnoreInput ()
 
virtual EMouseCaptureMode GetMouseCaptureMode () const
 
virtual bool CaptureMouseOnLaunch ()
 
virtual bool LockDuringCapture ()
 
virtual bool ShouldAlwaysLockMouse ()
 
virtual bool HideCursorDuringCapture () const
 
virtual ENGINE_API FPopupMethodReply OnQueryPopupMethod () const
 
virtual bool HandleNavigation (const uint32 InUserIndex, TSharedPtr< SWidget > InDestination)
 
virtual bool ShouldDPIScaleSceneCanvas () const
 

Protected Member Functions

virtual float UpdateViewportClientWindowDPIScale () const
 

Detailed Description

Common functionality for game and editor viewport clients

Constructor & Destructor Documentation

◆ FCommonViewportClient()

FCommonViewportClient::FCommonViewportClient ( )
inline

◆ ~FCommonViewportClient()

FCommonViewportClient::~FCommonViewportClient ( )
overridevirtual

Member Function Documentation

◆ DrawHighResScreenshotCaptureRegion()

void FCommonViewportClient::DrawHighResScreenshotCaptureRegion ( FCanvas &  Canvas)

◆ GetDPIDerivedResolutionFraction()

float FCommonViewportClient::GetDPIDerivedResolutionFraction ( ) const
Returns
the current resolution fraction to be used for scene rendering in this client.

◆ GetDPIScale()

float FCommonViewportClient::GetDPIScale ( ) const
overridevirtual
Returns
The DPI Scale of this viewport

Reimplemented from FViewportClient.

◆ RequestUpdateDPIScale()

void FCommonViewportClient::RequestUpdateDPIScale ( )

Tells this viewport to update editor dpi scale when needed

◆ UpdateViewportClientWindowDPIScale()

virtual float FCommonViewportClient::UpdateViewportClientWindowDPIScale ( ) const
inlineprotectedvirtual
Returns
the DPI scale of the window that the viewport client is in

Reimplemented in UGameViewportClient.

The documentation for this class was generated from the following files: