Struct TouchHistory | Input System | 1.0.2
docs.unity.cn
    Show / Hide Table of Contents

    Struct TouchHistory

    A fixed-size buffer of Touch records used to trace the history of touches.

    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    ValueType.ToString()
    Namespace: UnityEngine.InputSystem.EnhancedTouch
    Syntax
    public struct TouchHistory : IReadOnlyList<Touch>
    Remarks

    This struct provides access to a recorded list of touches.

    Properties

    Count

    Number of history records available.

    Declaration
    public int Count { get; }
    Property Value
    Type Description
    Int32

    Item[Int32]

    Return a history record by index. Indexing starts at 0 == newest to Count - 1 == oldest.

    Declaration
    public Touch this[int index] { get; }
    Parameters
    Type Name Description
    Int32 index

    Index of history record.

    Property Value
    Type Description
    Touch
    Exceptions
    Type Condition
    ArgumentOutOfRangeException

    index is less than 0 or >= Count.

    Methods

    GetEnumerator()

    Enumerate touches in the history. Goes from newest records to oldest.

    Declaration
    public IEnumerator<Touch> GetEnumerator()
    Returns
    Type Description
    IEnumerator<Touch>

    Enumerator over the touches in the history.

    Explicit Interface Implementations

    IEnumerable.GetEnumerator()

    Declaration
    IEnumerator IEnumerable.GetEnumerator()
    Returns
    Type Description
    IEnumerator
    Back to top Copyright © 2020 Unity Technologies
    Generated by DocFX
    on 22 January 2021