// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. #nullable disable using System; using System.Diagnostics; using System.Runtime.InteropServices; using osu.Framework.Allocation; using osu.Framework.Extensions.EnumExtensions; using osu.Framework.Graphics; using osu.Framework.Graphics.Primitives; using osu.Framework.Graphics.Rendering; using osu.Framework.Graphics.Rendering.Vertices; using osu.Framework.Graphics.Shaders; using osu.Framework.Graphics.Shaders.Types; using osu.Framework.Graphics.Textures; using osu.Framework.Input; using osu.Framework.Input.Events; using osu.Framework.Layout; using osu.Framework.Timing; using osuTK; using osuTK.Graphics; using osuTK.Graphics.ES30; namespace osu.Game.Rulesets.Osu.UI.Cursor { public partial class CursorTrail : Drawable, IRequireHighFrequencyMousePosition { private const int max_sprites = 2048; /// /// An exponentiating factor to ease the trail fade. /// protected virtual float FadeExponent => 1.7f; private readonly TrailPart[] parts = new TrailPart[max_sprites]; private int currentIndex; private IShader shader; private double timeOffset; private float time; private Anchor trailOrigin = Anchor.Centre; protected Anchor TrailOrigin { get => trailOrigin; set { trailOrigin = value; Invalidate(Invalidation.DrawNode); } } public CursorTrail() { // as we are currently very dependent on having a running clock, let's make our own clock for the time being. Clock = new FramedClock(); RelativeSizeAxes = Axes.Both; for (int i = 0; i < max_sprites; i++) { // -1 signals that the part is unusable, and should not be drawn parts[i].InvalidationID = -1; } AddLayout(partSizeCache); } [BackgroundDependencyLoader] private void load(IRenderer renderer, ShaderManager shaders) { texture ??= renderer.WhitePixel; shader = shaders.Load(@"CursorTrail", FragmentShaderDescriptor.TEXTURE); } protected override void LoadComplete() { base.LoadComplete(); resetTime(); } private Texture texture; public Texture Texture { get => texture; set { if (texture == value) return; texture = value; Invalidate(Invalidation.DrawNode); } } private readonly LayoutValue partSizeCache = new LayoutValue(Invalidation.DrawInfo | Invalidation.RequiredParentSizeToFit | Invalidation.Presence); private Vector2 partSize => partSizeCache.IsValid ? partSizeCache.Value : (partSizeCache.Value = new Vector2(Texture.DisplayWidth, Texture.DisplayHeight) * DrawInfo.Matrix.ExtractScale().Xy); /// /// The amount of time to fade the cursor trail pieces. /// protected virtual double FadeDuration => 300; public override bool IsPresent => true; protected override void Update() { base.Update(); Invalidate(Invalidation.DrawNode); const int fade_clock_reset_threshold = 1000000; time = (float)((Time.Current - timeOffset) / FadeDuration); if (time > fade_clock_reset_threshold) resetTime(); } private void resetTime() { for (int i = 0; i < parts.Length; ++i) { parts[i].Time -= time; if (parts[i].InvalidationID != -1) ++parts[i].InvalidationID; } time = 0; timeOffset = Time.Current; } /// /// Whether to interpolate mouse movements and add trail pieces at intermediate points. /// protected virtual bool InterpolateMovements => true; protected virtual float IntervalMultiplier => 1.0f; protected virtual bool AvoidDrawingNearCursor => false; private Vector2? lastPosition; private readonly InputResampler resampler = new InputResampler(); public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) => true; protected override bool OnMouseMove(MouseMoveEvent e) { AddTrail(e.ScreenSpaceMousePosition); return base.OnMouseMove(e); } protected void AddTrail(Vector2 position) { if (InterpolateMovements) { if (!lastPosition.HasValue) { lastPosition = position; resampler.AddPosition(lastPosition.Value); return; } foreach (Vector2 pos2 in resampler.AddPosition(position)) { Trace.Assert(lastPosition.HasValue); Vector2 pos1 = lastPosition.Value; Vector2 diff = pos2 - pos1; float distance = diff.Length; Vector2 direction = diff / distance; float interval = partSize.X / 2.5f * IntervalMultiplier; float stopAt = distance - (AvoidDrawingNearCursor ? interval : 0); for (float d = interval; d < stopAt; d += interval) { lastPosition = pos1 + direction * d; addPart(lastPosition.Value); } } } else { lastPosition = position; addPart(lastPosition.Value); } } private void addPart(Vector2 screenSpacePosition) { parts[currentIndex].Position = screenSpacePosition; parts[currentIndex].Time = time + 1; ++parts[currentIndex].InvalidationID; currentIndex = (currentIndex + 1) % max_sprites; } protected override DrawNode CreateDrawNode() => new TrailDrawNode(this); private struct TrailPart { public Vector2 Position; public float Time; public long InvalidationID; } private class TrailDrawNode : DrawNode { protected new CursorTrail Source => (CursorTrail)base.Source; private IShader shader; private Texture texture; private float time; private float fadeExponent; private readonly TrailPart[] parts = new TrailPart[max_sprites]; private Vector2 size; private Vector2 originPosition; private IVertexBatch vertexBatch; public TrailDrawNode(CursorTrail source) : base(source) { } public override void ApplyState() { base.ApplyState(); shader = Source.shader; texture = Source.texture; size = Source.partSize; time = Source.time; fadeExponent = Source.FadeExponent; originPosition = Vector2.Zero; if (Source.TrailOrigin.HasFlagFast(Anchor.x1)) originPosition.X = 0.5f; else if (Source.TrailOrigin.HasFlagFast(Anchor.x2)) originPosition.X = 1f; if (Source.TrailOrigin.HasFlagFast(Anchor.y1)) originPosition.Y = 0.5f; else if (Source.TrailOrigin.HasFlagFast(Anchor.y2)) originPosition.Y = 1f; Source.parts.CopyTo(parts, 0); } private IUniformBuffer cursorTrailParameters; public override void Draw(IRenderer renderer) { base.Draw(renderer); vertexBatch ??= renderer.CreateQuadBatch(max_sprites, 1); cursorTrailParameters ??= renderer.CreateUniformBuffer(); cursorTrailParameters.Data = cursorTrailParameters.Data with { FadeClock = time, FadeExponent = fadeExponent }; shader.Bind(); shader.BindUniformBlock("m_CursorTrailParameters", cursorTrailParameters); texture.Bind(); RectangleF textureRect = texture.GetTextureRect(); foreach (var part in parts) { if (part.InvalidationID == -1) continue; if (time - part.Time >= 1) continue; vertexBatch.Add(new TexturedTrailVertex(renderer) { Position = new Vector2(part.Position.X - size.X * originPosition.X, part.Position.Y + size.Y * (1 - originPosition.Y)), TexturePosition = textureRect.BottomLeft, TextureRect = new Vector4(0, 0, 1, 1), Colour = DrawColourInfo.Colour.BottomLeft.Linear, Time = part.Time }); vertexBatch.Add(new TexturedTrailVertex(renderer) { Position = new Vector2(part.Position.X + size.X * (1 - originPosition.X), part.Position.Y + size.Y * (1 - originPosition.Y)), TexturePosition = textureRect.BottomRight, TextureRect = new Vector4(0, 0, 1, 1), Colour = DrawColourInfo.Colour.BottomRight.Linear, Time = part.Time }); vertexBatch.Add(new TexturedTrailVertex(renderer) { Position = new Vector2(part.Position.X + size.X * (1 - originPosition.X), part.Position.Y - size.Y * originPosition.Y), TexturePosition = textureRect.TopRight, TextureRect = new Vector4(0, 0, 1, 1), Colour = DrawColourInfo.Colour.TopRight.Linear, Time = part.Time }); vertexBatch.Add(new TexturedTrailVertex(renderer) { Position = new Vector2(part.Position.X - size.X * originPosition.X, part.Position.Y - size.Y * originPosition.Y), TexturePosition = textureRect.TopLeft, TextureRect = new Vector4(0, 0, 1, 1), Colour = DrawColourInfo.Colour.TopLeft.Linear, Time = part.Time }); } vertexBatch.Draw(); shader.Unbind(); } protected override void Dispose(bool isDisposing) { base.Dispose(isDisposing); vertexBatch?.Dispose(); cursorTrailParameters?.Dispose(); } [StructLayout(LayoutKind.Sequential, Pack = 1)] private record struct CursorTrailParameters { public UniformFloat FadeClock; public UniformFloat FadeExponent; private readonly UniformPadding8 pad1; } } [StructLayout(LayoutKind.Sequential)] public struct TexturedTrailVertex : IEquatable, IVertex { [VertexMember(2, VertexAttribPointerType.Float)] public Vector2 Position; [VertexMember(4, VertexAttribPointerType.Float)] public Color4 Colour; [VertexMember(2, VertexAttribPointerType.Float)] public Vector2 TexturePosition; [VertexMember(4, VertexAttribPointerType.Float)] public Vector4 TextureRect; [VertexMember(1, VertexAttribPointerType.Float)] public float Time; [VertexMember(1, VertexAttribPointerType.Int)] private readonly int maskingIndex; public TexturedTrailVertex(IRenderer renderer) { this = default; maskingIndex = renderer.CurrentMaskingIndex; } public bool Equals(TexturedTrailVertex other) { return Position.Equals(other.Position) && TexturePosition.Equals(other.TexturePosition) && Colour.Equals(other.Colour) && Time.Equals(other.Time) && maskingIndex == other.maskingIndex; } } } }