logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Struct PrimaryJoinInfo

    Struct representing primary join information for a player input device.

    Inherited Members
    ValueType.Equals(object)
    ValueType.GetHashCode()
    ValueType.ToString()
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetType()
    Namespace: Serenity.InputGateway.Domain.Structs
    Assembly: Serenity.InputGateway.Domain.dll
    Syntax
    public readonly struct PrimaryJoinInfo

    Constructors

    PrimaryJoinInfo(int?, string, string, string, InputDeviceKind)

    Initializes a new instance of the PrimaryJoinInfo struct.

    Declaration
    public PrimaryJoinInfo(int? userIndex, string controlScheme, string deviceId, string deviceDisplayName, InputDeviceKind deviceKind)
    Parameters
    Type Name Description
    int? userIndex

    The user index associated with the input device.

    string controlScheme

    The control scheme associated with the input device.

    string deviceId

    The device ID of the input device.

    string deviceDisplayName

    The display name of the input device.

    InputDeviceKind deviceKind

    The kind of the input device.

    Fields

    ControlScheme

    Declaration
    public readonly string ControlScheme
    Field Value
    Type Description
    string

    Gets the control scheme associated with the input device.

    DeviceDisplayName

    Declaration
    public readonly string DeviceDisplayName
    Field Value
    Type Description
    string

    Gets the display name of the input device.

    DeviceId

    Declaration
    public readonly string DeviceId
    Field Value
    Type Description
    string

    Gets the device ID of the input device.

    DeviceKind

    Declaration
    public readonly InputDeviceKind DeviceKind
    Field Value
    Type Description
    InputDeviceKind

    Gets the kind of the input device.

    UserIndex

    Declaration
    public readonly int? UserIndex
    Field Value
    Type Description
    int?

    Gets the user index associated with the input device.

    In this article
    © 2026 Serenity. All Rights Reserved