docs.unity3d.com
    Show / Hide Table of Contents

    Struct InputControlLayout.Builder.ControlBuilder

    Syntax for configuring an individual InputControlLayout.ControlItem.

    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    ValueType.ToString()
    Namespace: UnityEngine.InputSystem.Layouts
    Syntax
    public struct ControlBuilder

    Methods

    AsArrayOfControlsWithSize(Int32)

    Declaration
    public InputControlLayout.Builder.ControlBuilder AsArrayOfControlsWithSize(int arraySize)
    Parameters
    Type Name Description
    Int32 arraySize
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    DontReset(Boolean)

    Declaration
    public InputControlLayout.Builder.ControlBuilder DontReset(bool value)
    Parameters
    Type Name Description
    Boolean value
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    IsNoisy(Boolean)

    Declaration
    public InputControlLayout.Builder.ControlBuilder IsNoisy(bool value)
    Parameters
    Type Name Description
    Boolean value
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    IsSynthetic(Boolean)

    Declaration
    public InputControlLayout.Builder.ControlBuilder IsSynthetic(bool value)
    Parameters
    Type Name Description
    Boolean value
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    UsingStateFrom(String)

    Declaration
    public InputControlLayout.Builder.ControlBuilder UsingStateFrom(string path)
    Parameters
    Type Name Description
    String path
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    WithBitOffset(UInt32)

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithBitOffset(uint bit)
    Parameters
    Type Name Description
    UInt32 bit
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    WithByteOffset(UInt32)

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithByteOffset(uint offset)
    Parameters
    Type Name Description
    UInt32 offset
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    WithDefaultState(PrimitiveValue)

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithDefaultState(PrimitiveValue value)
    Parameters
    Type Name Description
    PrimitiveValue value
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    WithDisplayName(String)

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithDisplayName(string displayName)
    Parameters
    Type Name Description
    String displayName
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    WithFormat(String)

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithFormat(string format)
    Parameters
    Type Name Description
    String format
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    WithFormat(FourCC)

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithFormat(FourCC format)
    Parameters
    Type Name Description
    FourCC format
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    WithLayout(String)

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithLayout(string layout)
    Parameters
    Type Name Description
    String layout
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    WithParameters(String)

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithParameters(string parameters)
    Parameters
    Type Name Description
    String parameters
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    WithProcessors(String)

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithProcessors(string processors)
    Parameters
    Type Name Description
    String processors
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    WithRange(Single, Single)

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithRange(float minValue, float maxValue)
    Parameters
    Type Name Description
    Single minValue
    Single maxValue
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    WithSizeInBits(UInt32)

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithSizeInBits(uint sizeInBits)
    Parameters
    Type Name Description
    UInt32 sizeInBits
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    WithUsages(IEnumerable<String>)

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithUsages(IEnumerable<string> usages)
    Parameters
    Type Name Description
    IEnumerable<String> usages
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    WithUsages(String[])

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithUsages(params string[] usages)
    Parameters
    Type Name Description
    String[] usages
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder

    WithUsages(InternedString[])

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithUsages(params InternedString[] usages)
    Parameters
    Type Name Description
    InternedString[] usages
    Returns
    Type Description
    InputControlLayout.Builder.ControlBuilder
    In This Article
    • Methods
      • AsArrayOfControlsWithSize(Int32)
      • DontReset(Boolean)
      • IsNoisy(Boolean)
      • IsSynthetic(Boolean)
      • UsingStateFrom(String)
      • WithBitOffset(UInt32)
      • WithByteOffset(UInt32)
      • WithDefaultState(PrimitiveValue)
      • WithDisplayName(String)
      • WithFormat(String)
      • WithFormat(FourCC)
      • WithLayout(String)
      • WithParameters(String)
      • WithProcessors(String)
      • WithRange(Single, Single)
      • WithSizeInBits(UInt32)
      • WithUsages(IEnumerable<String>)
      • WithUsages(String[])
      • WithUsages(InternedString[])
    Back to top
    Terms of use
    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