Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Display.RelativeMouseAt

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

Sumbission failed

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

Close

Cancel

Switch to Manual
public static function RelativeMouseAt(inputMouseCoordinates: Vector3): Vector3;
public static Vector3 RelativeMouseAt(Vector3 inputMouseCoordinates);

Parameters

inputMouseCoordinatesMouse Input Position as Coordinates.

Description

Query relative mouse coordinates.

RelativeMouseAt can be used to query relative mouse input coordinates and the screen in which Mouse Input is recorded. This is only valid on the Windows Desktop platforms with Multiple Displays. x, y returns the coordinates in relative space and z returns the screen in which Mouse Input is handled.

Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download