Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > GameFramework > FInputModeGameAndUI

Light Theme

Dark Theme

FInputModeGameAndUI

Data structure used to setup an input mode that allows the UI to respond to user input, and if the UI doesn't handle it player input / player controller gets a chance.

Windows

MacOS

Linux

Inheritance Hierarchy

FInputModeDataBase

FInputModeGameAndUI

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/GameFramework/PlayerController.h
Include	#include "GameFramework/PlayerController.h"

Syntax

struct FInputModeGameAndUI : public FInputModeDataBase

Remarks

Data structure used to setup an input mode that allows the UI to respond to user input, and if the UI doesn't handle it player input / player controller gets a chance.

Variables

		Name	Description
	bool	bHideCursorDuringCapture
	EMouseLockMode	MouseLockMode
	TSharedPtr< SWi...	WidgetToFocus

Constructors

	Name	Description
	FInputModeGameAndUI()

Functions

	Name	Description
FInputModeGa...	SetHideCursorDuringCapture ( bool InHideCursorDuringCapture )	Whether to hide the cursor during temporary mouse capture caused by a mouse down
FInputModeGa...	SetLockMouseToViewportBehavior ( EMouseLockMode InMouseLockMode )	Sets the mouse locking behavior of the viewport
FInputModeGa...	SetWidgetToFocus ( TSharedPtr< SWidget > InWidgetToFoc... )	Widget to focus

Overridden from FInputModeDataBase

		Name	Description
	void	ApplyInputMode ( FReply& SlateOperations, UGameViewportClient& GameViewportC... )	Derived classes override this function to apply the necessary settings for the desired input mode

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss