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 > Engine > EMouseCaptureMode

Light Theme

Dark Theme

EMouseCaptureMode

Windows

MacOS

Linux

References

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

Syntax

enum EMouseCaptureMode
{
    NoCapture,
    CapturePermanently,
    CapturePermanently_IncludingInitialMouseDown,
    CaptureDuringMouseDown,
    CaptureDuringRightMouseDown,
}

Values

Name	Description
NoCapture	Do not capture the mouse at all
CapturePermanently	Capture the mouse permanently when the viewport is clicked, and consume the initial mouse down that caused the capture so it isn't processed by player input
CapturePermanently_IncludingInitialMouseDown	Capture the mouse permanently when the viewport is clicked, and allow player input to process the mouse down that caused the capture
CaptureDuringMouseDown	Capture the mouse during a mouse down, releases on mouse up
CaptureDuringRightMouseDown	Capture only when the right mouse button is down, not any of the other mouse buttons

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

Take our survey

Dismiss