Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

Input.mousePositionDelta

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static Vector3 mousePositionDelta;

Description

The current mouse position delta in pixel coordinates. (Read Only).

Note: This API is part of the legacy Input class, and not recommended for new projects. The documentation is provided here to support legacy projects that use the old Input Manager and Input class. For new projects you should use the newer and Input System Package. (read more).

Input.mousePositionDelta is a Vector3 for compatibility with functions that have Vector3 arguments. The z component of the Vector3 is always 0.

Note: You should use Input.mousePositionDelta instead of [[Input.mousePosition] when Cursor.lockState is set to CursorLockMode.Locked, since when cursor is locked, the mouse position remains stationary when moving the mouse, thus only position delta gives you the information about mouse movement.