2019-01-24 16:43:03 +08:00
|
|
|
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
|
|
|
|
// See the LICENCE file in the repository root for full licence text.
|
2018-04-13 17:19:50 +08:00
|
|
|
|
2022-06-17 15:37:17 +08:00
|
|
|
#nullable disable
|
|
|
|
|
2018-01-12 17:13:17 +08:00
|
|
|
using osu.Framework.Graphics;
|
|
|
|
using osu.Framework.Graphics.Cursor;
|
2018-04-13 17:19:50 +08:00
|
|
|
|
2018-01-12 17:13:17 +08:00
|
|
|
namespace osu.Game.Graphics.Cursor
|
|
|
|
{
|
2018-01-12 18:37:57 +08:00
|
|
|
/// <summary>
|
|
|
|
/// Interface for <see cref="IDrawable"/>s that display cursors which can replace the user's cursor.
|
|
|
|
/// </summary>
|
2018-01-12 18:36:35 +08:00
|
|
|
public interface IProvideCursor : IDrawable
|
2018-01-12 17:13:17 +08:00
|
|
|
{
|
|
|
|
/// <summary>
|
2018-01-15 13:07:09 +08:00
|
|
|
/// The cursor provided by this <see cref="IDrawable"/>.
|
2018-01-12 18:37:57 +08:00
|
|
|
/// May be null if no cursor should be visible.
|
2018-01-12 17:13:17 +08:00
|
|
|
/// </summary>
|
2022-10-11 21:20:57 +08:00
|
|
|
CursorContainer Cursor { get; }
|
2018-04-13 17:19:50 +08:00
|
|
|
|
2018-01-12 17:13:17 +08:00
|
|
|
/// <summary>
|
2022-10-11 21:20:57 +08:00
|
|
|
/// Whether <see cref="Cursor"/> should be displayed as the singular user cursor. This will temporarily hide any other user cursor.
|
2018-01-15 13:07:09 +08:00
|
|
|
/// This value is checked every frame and may be used to control whether multiple cursors are displayed (e.g. watching replays).
|
2018-01-12 17:13:17 +08:00
|
|
|
/// </summary>
|
2018-01-15 13:07:09 +08:00
|
|
|
bool ProvidingUserCursor { get; }
|
2018-01-12 17:13:17 +08:00
|
|
|
}
|
|
|
|
}
|