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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback