Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    InputSourceBase Class

    Namespace: Stride.Input
    Assembly: Stride.Input.dll

    Base class for input sources, implements common parts of the IInputSource interface and keeps track of registered devices through RegisterDevice(IInputDevice) and UnregisterDevice(IInputDevice)

    System.Object → InputSourceBase
    Derived from InputSourceBase: InputSourceSimulated

    public abstract class InputSourceBase : IInputSource, IDisposable
    Name Description
    Properties
    Devices
    Methods
    Dispose()

    Unregisters all devices registered with RegisterDevice(IInputDevice) which have not been unregistered yet

    Initialize(InputManager)
    Pause()
    RegisterDevice(IInputDevice)

    Adds the device to the list Devices

    Resume()
    Scan()
    UnregisterDevice(IInputDevice)

    CRemoves the device from the list Devices

    Update()
    | Improve this Doc View Source

    Properties


    Devices

    public TrackingDictionary<Guid, IInputDevice> Devices { get; }
    Property Value
    Type Description
    TrackingDictionary<System.Guid, IInputDevice>
    | Improve this Doc View Source

    Methods


    Dispose()

    Unregisters all devices registered with RegisterDevice(IInputDevice) which have not been unregistered yet

    public virtual void Dispose()

    Initialize(InputManager)

    public abstract void Initialize(InputManager inputManager)
    Parameters
    Type Name Description
    InputManager inputManager

    Pause()

    public virtual void Pause()

    RegisterDevice(IInputDevice)

    Adds the device to the list Devices

    protected void RegisterDevice(IInputDevice device)
    Parameters
    Type Name Description
    IInputDevice device

    The device


    Resume()

    public virtual void Resume()

    Scan()

    public virtual void Scan()

    UnregisterDevice(IInputDevice)

    CRemoves the device from the list Devices

    protected void UnregisterDevice(IInputDevice device)
    Parameters
    Type Name Description
    IInputDevice device

    The device


    Update()

    public virtual void Update()

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation