Class MousePositionDebug | Core RP Library | 7.2.1
docs.unity3d.com
    Show / Hide Table of Contents

    Class MousePositionDebug

    Provides mouse position for debugging purpose.

    Inheritance
    Object
    MousePositionDebug
    Namespace: UnityEngine.Rendering
    Syntax
    public class MousePositionDebug

    Properties

    instance

    Singleton instance.

    Declaration
    public static MousePositionDebug instance { get; }
    Property Value
    Type Description
    MousePositionDebug

    Methods

    Build()

    Initialize the MousePositionDebug class.

    Declaration
    public void Build()

    Cleanup()

    Cleanup the MousePositionDebug class.

    Declaration
    public void Cleanup()

    GetMouseClickPosition(Single)

    Returns the position of the mouse click.

    Declaration
    public Vector2 GetMouseClickPosition(float ScreenHeight)
    Parameters
    Type Name Description
    Single ScreenHeight

    Window height.

    Returns
    Type Description
    Vector2

    The coordinates of the mouse click.

    GetMousePosition(Single, Boolean)

    Get the mouse position in the scene or game view.

    Declaration
    public Vector2 GetMousePosition(float ScreenHeight, bool sceneView)
    Parameters
    Type Name Description
    Single ScreenHeight

    Window height.

    Boolean sceneView

    Get position in the scene view?

    Returns
    Type Description
    Vector2

    Coordinates of the mouse in the specified window.

    In This Article
    • Properties
      • instance
    • Methods
      • Build()
      • Cleanup()
      • GetMouseClickPosition(Single)
      • GetMousePosition(Single, Boolean)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023