docs.unity3d.com
Search Results for

    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
    Assembly: Unity.InputSystem.dll
    Syntax
    public struct InputControlLayout.Builder.ControlBuilder

    Methods

    AsArrayOfControlsWithSize(int)

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

    DontReset(bool)

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

    IsNoisy(bool)

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

    IsSynthetic(bool)

    Declaration
    public InputControlLayout.Builder.ControlBuilder IsSynthetic(bool value)
    Parameters
    Type Name Description
    bool 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(uint)

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

    WithByteOffset(uint)

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithByteOffset(uint offset)
    Parameters
    Type Name Description
    uint 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(float, float)

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

    WithSizeInBits(uint)

    Declaration
    public InputControlLayout.Builder.ControlBuilder WithSizeInBits(uint sizeInBits)
    Parameters
    Type Name Description
    uint 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(params string[])

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

    WithUsages(params InternedString[])

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

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Methods
      • AsArrayOfControlsWithSize(int)
      • DontReset(bool)
      • IsNoisy(bool)
      • IsSynthetic(bool)
      • UsingStateFrom(string)
      • WithBitOffset(uint)
      • WithByteOffset(uint)
      • WithDefaultState(PrimitiveValue)
      • WithDisplayName(string)
      • WithFormat(string)
      • WithFormat(FourCC)
      • WithLayout(string)
      • WithParameters(string)
      • WithProcessors(string)
      • WithRange(float, float)
      • WithSizeInBits(uint)
      • WithUsages(IEnumerable<string>)
      • WithUsages(params string[])
      • WithUsages(params InternedString[])
    Back to top
    Copyright © 2024 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)