EMouseCaptureMode

Choose your operating system:

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