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

    Struct HID.HIDElementDescriptor

    Descriptor for a single report element.

    Namespace: UnityEngine.InputSystem.HID
    Syntax
    [Serializable]
    public struct HIDElementDescriptor

    Fields

    collectionIndex

    Declaration
    public int collectionIndex
    Field Value
    Type Description
    System.Int32

    flags

    Declaration
    public HID.HIDElementFlags flags
    Field Value
    Type Description
    HID.HIDElementFlags

    logicalMax

    Declaration
    public int logicalMax
    Field Value
    Type Description
    System.Int32

    logicalMin

    Declaration
    public int logicalMin
    Field Value
    Type Description
    System.Int32

    physicalMax

    Declaration
    public int physicalMax
    Field Value
    Type Description
    System.Int32

    physicalMin

    Declaration
    public int physicalMin
    Field Value
    Type Description
    System.Int32

    reportId

    Declaration
    public int reportId
    Field Value
    Type Description
    System.Int32

    reportOffsetInBits

    Declaration
    public int reportOffsetInBits
    Field Value
    Type Description
    System.Int32

    reportSizeInBits

    Declaration
    public int reportSizeInBits
    Field Value
    Type Description
    System.Int32

    reportType

    Declaration
    public HID.HIDReportType reportType
    Field Value
    Type Description
    HID.HIDReportType

    unit

    Declaration
    public int unit
    Field Value
    Type Description
    System.Int32

    unitExponent

    Declaration
    public int unitExponent
    Field Value
    Type Description
    System.Int32

    usage

    Declaration
    public int usage
    Field Value
    Type Description
    System.Int32

    usageMax

    Declaration
    public int? usageMax
    Field Value
    Type Description
    System.Nullable<System.Int32>

    usageMin

    Declaration
    public int? usageMin
    Field Value
    Type Description
    System.Nullable<System.Int32>

    usagePage

    Declaration
    public HID.UsagePage usagePage
    Field Value
    Type Description
    HID.UsagePage

    Properties

    hasNullState

    Declaration
    public bool hasNullState { get; }
    Property Value
    Type Description
    System.Boolean

    hasPreferredState

    Declaration
    public bool hasPreferredState { get; }
    Property Value
    Type Description
    System.Boolean

    isArray

    Declaration
    public bool isArray { get; }
    Property Value
    Type Description
    System.Boolean

    isConstant

    Declaration
    public bool isConstant { get; }
    Property Value
    Type Description
    System.Boolean

    isNonLinear

    Declaration
    public bool isNonLinear { get; }
    Property Value
    Type Description
    System.Boolean

    isRelative

    Declaration
    public bool isRelative { get; }
    Property Value
    Type Description
    System.Boolean

    isWrapping

    Declaration
    public bool isWrapping { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    Is(HID.UsagePage, Int32)

    Declaration
    public bool Is(HID.UsagePage usagePage, int usage)
    Parameters
    Type Name Description
    HID.UsagePage usagePage
    System.Int32 usage
    Returns
    Type Description
    System.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