docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class PointerInputModule

    A BaseInputModule for pointer input.

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    UIBehaviour
    BaseInputModule
    PointerInputModule
    StandaloneInputModule
    Inherited Members
    BaseInputModule.m_RaycastResultCache
    BaseInputModule.sendPointerHoverToParent
    BaseInputModule.m_InputOverride
    BaseInputModule.input
    BaseInputModule.inputOverride
    BaseInputModule.eventSystem
    BaseInputModule.OnEnable()
    BaseInputModule.OnDisable()
    BaseInputModule.Process()
    BaseInputModule.FindFirstRaycast(List<RaycastResult>)
    BaseInputModule.DetermineMoveDirection(float, float)
    BaseInputModule.DetermineMoveDirection(float, float, float)
    BaseInputModule.FindCommonRoot(GameObject, GameObject)
    BaseInputModule.HandlePointerExitAndEnter(PointerEventData, GameObject)
    BaseInputModule.GetAxisEventData(float, float, float)
    BaseInputModule.GetBaseEventData()
    BaseInputModule.ShouldActivateModule()
    BaseInputModule.DeactivateModule()
    BaseInputModule.ActivateModule()
    BaseInputModule.UpdateModule()
    BaseInputModule.IsModuleSupported()
    BaseInputModule.ConvertUIToolkitPointerId(PointerEventData)
    BaseInputModule.ConvertPointerEventScrollDeltaToTicks(Vector2)
    BaseInputModule.GetNavigationEventDeviceType(BaseEventData)
    UIBehaviour.Awake()
    UIBehaviour.Start()
    UIBehaviour.OnDestroy()
    UIBehaviour.IsActive()
    UIBehaviour.OnValidate()
    UIBehaviour.Reset()
    UIBehaviour.OnRectTransformDimensionsChange()
    UIBehaviour.OnBeforeTransformParentChanged()
    UIBehaviour.OnTransformParentChanged()
    UIBehaviour.OnDidApplyAnimationProperties()
    UIBehaviour.OnCanvasGroupChanged()
    UIBehaviour.OnCanvasHierarchyChanged()
    UIBehaviour.IsDestroyed()
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(string, float)
    MonoBehaviour.InvokeRepeating(string, float, float)
    MonoBehaviour.CancelInvoke(string)
    MonoBehaviour.IsInvoking(string)
    MonoBehaviour.StartCoroutine(string)
    MonoBehaviour.StartCoroutine(string, object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(string)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(object)
    MonoBehaviour.destroyCancellationToken
    MonoBehaviour.useGUILayout
    MonoBehaviour.didStart
    MonoBehaviour.didAwake
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, out Component)
    Component.TryGetComponent<T>(out T)
    Component.GetComponent(string)
    Component.GetComponentInChildren(Type, bool)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(bool)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, bool)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(bool)
    Component.GetComponentsInChildren<T>(bool, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type, bool)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>(bool)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, bool)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(bool)
    Component.GetComponentsInParent<T>(bool, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.GetComponentIndex()
    Component.CompareTag(string)
    Component.CompareTag(TagHandle)
    Component.SendMessageUpwards(string, object, SendMessageOptions)
    Component.SendMessageUpwards(string, object)
    Component.SendMessageUpwards(string)
    Component.SendMessageUpwards(string, SendMessageOptions)
    Component.SendMessage(string, object)
    Component.SendMessage(string)
    Component.SendMessage(string, object, SendMessageOptions)
    Component.SendMessage(string, SendMessageOptions)
    Component.BroadcastMessage(string, object, SendMessageOptions)
    Component.BroadcastMessage(string, object)
    Component.BroadcastMessage(string)
    Component.BroadcastMessage(string, SendMessageOptions)
    Component.transform
    Component.transformHandle
    Component.gameObject
    Component.tag
    Object.GetEntityId()
    Object.MemberwiseClone()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.InstantiateAsync<T>(T)
    Object.InstantiateAsync<T>(T, Transform)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int)
    Object.InstantiateAsync<T>(T, int, Transform)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)
    Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Scene)
    Object.Instantiate<T>(T, InstantiateParameters)
    Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectsByType(Type)
    Object.FindObjectsByType(Type, FindObjectsInactive)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsByType<T>()
    Object.FindObjectsByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: UnityEngine.EventSystems
    Assembly: UnityEngine.UI.dll
    Syntax
    public abstract class PointerInputModule : BaseInputModule

    Fields

    kFakeTouchesId

    Touch id for when simulating touches on a non touch device.

    Declaration
    public const int kFakeTouchesId = -4
    Field Value
    Type Description
    int

    kMouseLeftId

    Id of the cached left mouse pointer event.

    Declaration
    public const int kMouseLeftId = -1
    Field Value
    Type Description
    int

    kMouseMiddleId

    Id of the cached middle mouse pointer event.

    Declaration
    public const int kMouseMiddleId = -3
    Field Value
    Type Description
    int

    kMouseRightId

    Id of the cached right mouse pointer event.

    Declaration
    public const int kMouseRightId = -2
    Field Value
    Type Description
    int

    m_PointerData

    The pointer event data for every active pointer, indexed by pointer ID.

    Declaration
    protected Dictionary<int, PointerEventData> m_PointerData
    Field Value
    Type Description
    Dictionary<int, PointerEventData>

    Methods

    ClearSelection()

    Clear all pointers and deselect any selected objects in the EventSystem.

    Declaration
    protected void ClearSelection()

    CopyFromTo(PointerEventData, PointerEventData)

    Copy one PointerEventData to another.

    Declaration
    protected void CopyFromTo(PointerEventData from, PointerEventData to)
    Parameters
    Type Name Description
    PointerEventData from

    The pointer event data to copy the values from.

    PointerEventData to

    The pointer event data to copy the values to.

    DeselectIfSelectionChanged(GameObject, BaseEventData)

    Deselect the current selected GameObject if the currently pointed-at GameObject is different.

    Declaration
    protected void DeselectIfSelectionChanged(GameObject currentOverGo, BaseEventData pointerEvent)
    Parameters
    Type Name Description
    GameObject currentOverGo

    The GameObject the pointer is currently over.

    BaseEventData pointerEvent

    Current event data.

    GetLastPointerEventData(int)

    Returns the last PointerEventData for the given touch or mouse ID.

    Declaration
    protected PointerEventData GetLastPointerEventData(int id)
    Parameters
    Type Name Description
    int id

    The touch or mouse ID of the pointer event data.

    Returns
    Type Description
    PointerEventData

    The last pointer event data of the given ID, or null if the pointer isn't tracked.

    GetMousePointerEventData()

    Returns the current MouseState for the default pointer.

    Declaration
    protected virtual PointerInputModule.MouseState GetMousePointerEventData()
    Returns
    Type Description
    PointerInputModule.MouseState

    The mouse state, with the left, right, and middle button data updated for this frame.

    GetMousePointerEventData(int)

    Updates and returns the current MouseState.

    Declaration
    protected virtual PointerInputModule.MouseState GetMousePointerEventData(int id)
    Parameters
    Type Name Description
    int id

    Ignored.

    Returns
    Type Description
    PointerInputModule.MouseState

    The mouse state, with the left, right, and middle button data updated for this frame.

    GetPointerData(int, out PointerEventData, bool)

    Search the cache for currently active pointers, return true if found.

    Declaration
    protected bool GetPointerData(int id, out PointerEventData data, bool create)
    Parameters
    Type Name Description
    int id

    Touch ID

    PointerEventData data

    Found data

    bool create

    If not found should it be created

    Returns
    Type Description
    bool

    True if pointer is found.

    GetTouchPointerEventData(Touch, out bool, out bool)

    Populates a PointerEventData object using touch input and determines if the touch was pressed or released.

    Declaration
    protected PointerEventData GetTouchPointerEventData(Touch input, out bool pressed, out bool released)
    Parameters
    Type Name Description
    Touch input

    The Touch input data to process into pointer event data.

    bool pressed

    Whether the touch began or is active this frame.

    bool released

    Whether the touch ended or was canceled this frame.

    Returns
    Type Description
    PointerEventData

    The PointerEventData for the touch.

    Remarks

    Builds or reuses PointerEventData for the touch and updates position, phase, and delta. The out parameters indicate if this frame is a press or release, which the event system uses to fire pointer down/up and click events.

    Examples

    Get touch data and forward press/release to pointer handlers. Requires an active touch and event system. The following forwards pointer down/up.

    Touch t = Input.GetTouch(0);
    bool pressed, released;
    PointerEventData data = GetTouchPointerEventData(t, out pressed, out released);
    if (pressed)
        ExecuteEvents.Execute(gameObject, data, ExecuteEvents.pointerDownHandler);
    if (released)
        ExecuteEvents.Execute(gameObject, data, ExecuteEvents.pointerUpHandler);

    IsPointerOverGameObject(int)

    If the module is pointer based, then override this to return true if the pointer is over an event system object.

    Declaration
    public override bool IsPointerOverGameObject(int pointerId)
    Parameters
    Type Name Description
    int pointerId

    The ID of the pointer.

    Returns
    Type Description
    bool

    True if the pointer is over an EventSystem object.

    Overrides
    BaseInputModule.IsPointerOverGameObject(int)

    ProcessDrag(PointerEventData)

    Process the drag for the current frame with the given pointer event.

    Declaration
    protected virtual void ProcessDrag(PointerEventData pointerEvent)
    Parameters
    Type Name Description
    PointerEventData pointerEvent

    The pointer event data for the drag.

    ProcessMove(PointerEventData)

    Process movement for the current frame with the given pointer event.

    Declaration
    protected virtual void ProcessMove(PointerEventData pointerEvent)
    Parameters
    Type Name Description
    PointerEventData pointerEvent

    The pointer event data for the movement.

    RemovePointerData(PointerEventData)

    Remove the PointerEventData from the cache.

    Declaration
    protected void RemovePointerData(PointerEventData data)
    Parameters
    Type Name Description
    PointerEventData data

    The pointer event data to remove.

    StateForMouseButton(int)

    Returns the current state for this frame for a given a mouse button ID.

    Declaration
    protected PointerEventData.FramePressState StateForMouseButton(int buttonId)
    Parameters
    Type Name Description
    int buttonId

    Mouse button ID

    Returns
    Type Description
    PointerEventData.FramePressState

    The press state of the button for this frame.

    ToString()

    Returns a multi-line string that lists the state of every tracked pointer.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    The formatted description of the input module state.

    Overrides
    Object.ToString()
    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)