Skip to content
MouseLockMode

UI / MouseLockMode

MouseLockMode Enumeration ​

Mouse Lock mode

Table of contents ​

Enumeration Members ​

DoNotLock = 0
LockAlways = 2
LockInFullscreen = 3
LockOnCapture = 1

Enumeration Members ​

DoNotLock ​

• DoNotLock = 0

Will not lock the mouse cursor to the viewport


LockAlways ​

• LockAlways = 2

Always lock the mouse cursor to the viewport


LockInFullscreen ​

• LockInFullscreen = 3

Lock the cursor when in full screen mode


LockOnCapture ​

• LockOnCapture = 1

Lock the mouse cursor to the viewport only when capturing the mouse