[ Web Proxy ]
URL:
Viewing: https://docs.unity3d.com/ScriptReference/Display.RelativeMouseAt.html [Back]  [Original]
Unity - Scripting API: Display.RelativeMouseAt
Version: Unity 6.5 (6000.5)
    • Supported
    • Legacy
    LanguageEnglish
    • C#

    Display.RelativeMouseAt

    Leave feedback
    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
    Your name Your email Suggestion* Submit suggestion

    Cancel

    Declaration

    public static Vector3 RelativeMouseAt(Vector3 inputMouseCoordinates);

    Parameters

    Parameter Description
    inputMouseCoordinates Mouse 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. x, y returns the coordinates in relative space and z returns the screen in which Mouse Input is handled, returns Vector3.zero when Multiple Displays are not supported. Currently implemented for Windows and macOS Standalone players.

    Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

    Copyright 2005-2026 Unity Technologies. All rights reserved. Built from job ID 74033673. Built on: 2026-08-24.
    Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Documentation Terms of Use Do Not Sell or Share My Personal Information
    Web Proxy Viewer  |  New URL  |  Original Page