Struct InputBindingCompositeContext | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Struct InputBindingCompositeContext

    Contextual data made available when processing values of composite bindings.

    Namespace: UnityEngine.InputSystem
    Syntax
    public struct InputBindingCompositeContext

    Methods

    ReadValue<TValue>(Int32)

    Declaration
    public TValue ReadValue<TValue>(int partNumber)
        where TValue : struct, IComparable<TValue>
    Parameters
    Type Name Description
    System.Int32 partNumber
    Returns
    Type Description
    TValue
    Type Parameters
    Name Description
    TValue

    ReadValue<TValue>(Int32, out InputControl)

    Declaration
    public TValue ReadValue<TValue>(int partNumber, out InputControl sourceControl)
        where TValue : struct, IComparable<TValue>
    Parameters
    Type Name Description
    System.Int32 partNumber
    InputControl sourceControl
    Returns
    Type Description
    TValue
    Type Parameters
    Name Description
    TValue

    ReadValue<TValue, TComparer>(Int32, TComparer)

    Declaration
    public TValue ReadValue<TValue, TComparer>(int partNumber, TComparer comparer = null)
        where TValue : struct where TComparer : IComparer<TValue>
    Parameters
    Type Name Description
    System.Int32 partNumber
    TComparer comparer
    Returns
    Type Description
    TValue
    Type Parameters
    Name Description
    TValue
    TComparer

    ReadValue<TValue, TComparer>(Int32, out InputControl, TComparer)

    Declaration
    public TValue ReadValue<TValue, TComparer>(int partNumber, out InputControl sourceControl, TComparer comparer = null)
        where TValue : struct where TComparer : IComparer<TValue>
    Parameters
    Type Name Description
    System.Int32 partNumber
    InputControl sourceControl
    TComparer comparer
    Returns
    Type Description
    TValue
    Type Parameters
    Name Description
    TValue
    TComparer

    ReadValueAsButton(Int32)

    Declaration
    public bool ReadValueAsButton(int partNumber)
    Parameters
    Type Name Description
    System.Int32 partNumber
    Returns
    Type Description
    System.Boolean

    See Also

    InputBindingComposite
    InputBindingComposite<TValue>
    ReadValue(InputBindingCompositeContext)
    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