RepoMirrors/osu
1
0
Fork 0
mirror of https://github.com/ppy/osu synced 2024-12-24 15:53:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve comments

Browse Source
This commit is contained in:
smoogipoo 2018-01-12 19:37:57 +09:00
parent 16d739580b
commit 34aee4fea0
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
osu.Game/Graphics/Cursor/IProvideCursor.cs
View File

@ -6,16 +6,19 @@ using osu.Framework.Graphics.Cursor;
namespace osu.Game.Graphics.Cursor
{
/// <summary>
/// Interface for <see cref="IDrawable"/>s that display cursors which can replace the user's cursor.
/// </summary>
public interface IProvideCursor : IDrawable
{
/// <summary>
/// The cursor provided by this <see cref="Drawable"/>.
/// May be null if no cursor should be visible.
/// </summary>
CursorContainer Cursor { get; }
/// <summary>
/// Whether the cursor provided by this <see cref="Drawable"/> should be displayed.
/// If this is false, a cursor occurring earlier in the draw hierarchy will be displayed instead.
/// Whether the cursor provided by this <see cref="Drawable"/> should be displayed as the user's cursor.
/// </summary>
bool ProvidesUserCursor { get; }
}