Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    IInputSource Interface

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

    An abstraction for a platform specific mechanism that provides input in the form of one of multiple IInputDevice(s). An input source is responsible for cleaning up it's own devices at cleanup

    public interface IInputSource : IDisposable
    Name Description
    Properties
    Devices

    All the input devices currently proviced by this source

    Methods
    Initialize(InputManager)

    Initializes the input source

    Pause()

    Called when input should be paused, for example when the application leaves the foreground

    Resume()

    Called when input should be resumed, when an application enters the forground

    Scan()

    Allows the source to take it's time to search for new devices

    Update()

    Update the input source and possibly add/remove input devices

    | Improve this Doc View Source

    Properties


    Devices

    All the input devices currently proviced by this source

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

    Methods


    Initialize(InputManager)

    Initializes the input source

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

    The InputManager initializing this source


    Pause()

    Called when input should be paused, for example when the application leaves the foreground

    void Pause()

    Resume()

    Called when input should be resumed, when an application enters the forground

    void Resume()

    Scan()

    Allows the source to take it's time to search for new devices

    void Scan()

    Update()

    Update the input source and possibly add/remove input devices

    void Update()

    Inherited Members

    System.IDisposable.Dispose()

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    • Improve this Doc
    • View Source
    In This Article
    In This Article
    • Properties
      • Devices
    • Methods
      • Initialize(InputManager)
      • Pause()
      • Resume()
      • Scan()
      • Update()
    • Inherited Members
    • Extension Methods

    Back to top

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