IInputContext.cs

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Collections.Generic;

namespace Silk.NET.Input
{
    /// <summary>
    /// An interface representing the input context.
    /// </summary>
    public interface IInputContext : IDisposable
    {
        /// <summary>
        /// A handle to the underlying input context.
        /// </summary>
        nint Handle { get; }

        /// <summary>
        /// A list of all available gamepads.
        /// </summary>
        IReadOnlyList<IGamepad> Gamepads { get; }

        /// <summary>
        /// A list of all available joysticks.
        /// </summary>
        IReadOnlyList<IJoystick> Joysticks { get; }

        /// <summary>
        /// A list of all available keyboards.
        /// <remarks>
        /// On some backends, this list may only contain 1 item. This is most likely because the underlying API doesn't
        /// support multiple keyboards.
        /// </remarks>
        /// </summary>
        IReadOnlyList<IKeyboard> Keyboards { get; }

        /// <summary>
        /// A list of all available mice.
        /// </summary>
        /// <remarks>
        /// On some backends, this list may only contain 1 item. This is most likely because the underlying API doesn't
        /// support multiple mice.
        /// </remarks>
        IReadOnlyList<IMouse> Mice { get; }

        /// <summary>
        /// A list of all available touch devices.
        /// </summary>
        /// <remarks>
        /// On some backends, this list may only contain 1 item. This is most likely because the underlying API doesn't
        /// support multiple touch devices.
        /// On some backends, this list might be empty. This is most likely because the underlying API doesn't
        /// support touch devices.
        /// </remarks>
        IReadOnlyList<ITouchDevice> TouchDevices { get; }

        /// <summary>
        /// The primary touch device if any.
        /// </summary>
        /// <remarks>
        /// On some backends this might just be an educated guess. Or might be null even though there are touch devices.
        /// </remarks>
        ITouchDevice? PrimaryTouchDevice { get; }

        /// <summary>
        /// A list of all other available input devices.
        /// </summary>
        /// <remarks>
        /// On some backends, this list might be empty. This is most likely because the underlying API doesn't
        /// support other devices.
        /// </remarks>
        IReadOnlyList<IInputDevice> OtherDevices { get; }

        /// <summary>
        /// Called when the connection status of a device changes.
        /// </summary>
        event Action<IInputDevice, bool>? ConnectionChanged;
    }
}