acdream/src/AcDream.App/Rendering/RetailCursorManager.cs
Erik 9d3df5f627 fix(app): #348 — cursor switches ride a process-lifetime native cache; the per-flip Win32 handle leak is closed
Silk's per-mouse ICursor recreates the native Win32 cursor on every
Image assignment; a per-frame cursor alternation (the pick cursor
flickering between kinds while hovering an ANIMATED NPC — exactly the
stand-at-a-vendor posture) allocated a fresh USER handle each flip
until CreateCursor died with "Not enough memory" and took the render
loop with it (vendor-gate.log, exit 82 — surfaced as one clean stack
by #343's fix, as designed).

GlfwCursorCache restores retail's own shape: each distinct
MediaDescCursor is created ONCE for the process lifetime
(glfwCreateCursor, rejected media cached as permanent misses) and
switching is an O(1) zero-allocation glfwSetCursor. The AP-72
missing-art standard-cursor fallback rides the same cache
(Arrow/Hand/Crosshair/IBeam; anything else keeps the Silk path).
Graphical hosts attach after the native window exists; tests and
windowless hosts keep the Silk path untouched. RetailCursorManager's
dedup and PlanApplication logic are unchanged.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-07 18:26:17 +02:00

231 lines
7.8 KiB
C#

using AcDream.App.UI;
using AcDream.Core.Textures;
using DatReaderWriter;
using AcDream.Content;
using DatReaderWriter.DBObjs;
using Silk.NET.Core;
using Silk.NET.Input;
namespace AcDream.App.Rendering;
/// <summary>Applies retail cursor feedback to Silk using dat MediaDescCursor art when available.</summary>
public sealed class RetailCursorManager
{
private readonly IDatReaderWriter _dats;
private readonly object _datLock;
private readonly RetailCursorResolver _globalCursors;
private readonly Dictionary<uint, RawImage> _imagesBySurface = new();
private readonly HashSet<uint> _missingSurfaces = new();
private readonly HashSet<RetailGlobalCursorKind> _reportedFallbacks = new();
private bool _hasLayerState;
private RetailGlobalCursorKind _lastGlobalKind;
private UiCursorMedia _lastWidgetCursor;
private UiCursorMedia _lastAppliedCursor;
private StandardCursor? _lastStandardCursor;
private GlfwCursorCache? _nativeCursors;
public RetailCursorManager(IDatReaderWriter dats, object datLock)
{
_dats = dats;
_datLock = datLock;
_globalCursors = new RetailCursorResolver(dats, datLock);
}
/// <summary>
/// #348: switches cursor application to a process-lifetime native
/// GLFW cursor cache. Without it, Silk recreates the native cursor
/// on every alternation and a per-frame flip (pick cursor over an
/// animated NPC) exhausts Win32 USER handles within minutes. No-op
/// when the handle is zero (tests, no native window) — the Silk
/// path below remains the fallback.
/// </summary>
public void AttachNativeWindow(nint glfwWindowHandle)
{
if (_nativeCursors is null)
{
_nativeCursors = GlfwCursorCache.TryCreate(glfwWindowHandle);
if (_nativeCursors is not null)
Console.WriteLine("[D.2b] cursor native cache attached (#348).");
}
}
public void Apply(IEnumerable<IMouse> mice, CursorFeedback feedback)
{
foreach (RetailCursorLayer layer in PlanApplication(
_hasLayerState,
_lastGlobalKind,
_lastWidgetCursor,
feedback.GlobalKind,
feedback.Cursor))
{
if (layer == RetailCursorLayer.Widget
&& feedback.Cursor.IsValid
&& TryGetImage(feedback.Cursor.File, out var image))
{
ApplyCustom(mice, feedback.Cursor, image);
}
else
{
ApplyGlobal(mice, feedback.GlobalKind);
}
}
_hasLayerState = true;
_lastGlobalKind = feedback.GlobalKind;
_lastWidgetCursor = feedback.Cursor;
}
private void ApplyGlobal(IEnumerable<IMouse> mice, RetailGlobalCursorKind kind)
{
if (_globalCursors.TryResolve(kind, out var globalCursor)
&& TryGetImage(globalCursor.File, out var globalImage))
{
ApplyCustom(mice, globalCursor, globalImage);
return;
}
if (_reportedFallbacks.Add(kind))
{
Console.Error.WriteLine(
$"[D.2b] retail cursor {kind} could not be resolved from DAT; " +
"using the registered OS cursor adaptation (AP-72).");
}
ApplyStandard(mice, StandardCursorFor(kind));
}
private void ApplyCustom(IEnumerable<IMouse> mice, UiCursorMedia cursorMedia, RawImage image)
{
if (_lastStandardCursor is null && _lastAppliedCursor.Equals(cursorMedia))
return;
if (_nativeCursors is not null && _nativeCursors.TrySetCustom(cursorMedia, image))
{
_lastAppliedCursor = cursorMedia;
_lastStandardCursor = null;
return;
}
foreach (var mouse in mice)
{
var cursor = mouse.Cursor;
cursor.Image = image;
cursor.HotspotX = cursorMedia.HotspotX;
cursor.HotspotY = cursorMedia.HotspotY;
if (cursor.Type != CursorType.Custom)
cursor.Type = CursorType.Custom;
}
_lastAppliedCursor = cursorMedia;
_lastStandardCursor = null;
}
private void ApplyStandard(IEnumerable<IMouse> mice, StandardCursor desired)
{
if (_lastStandardCursor == desired)
return;
if (_nativeCursors is not null && _nativeCursors.TrySetStandard(desired))
{
_lastAppliedCursor = default;
_lastStandardCursor = desired;
return;
}
foreach (var mouse in mice)
{
var cursor = mouse.Cursor;
var standard = desired;
if (!cursor.IsSupported(standard))
standard = StandardCursor.Arrow;
if (!cursor.IsSupported(standard))
continue;
if (cursor.Type != CursorType.Standard)
cursor.Type = CursorType.Standard;
if (cursor.StandardCursor != standard)
cursor.StandardCursor = standard;
}
_lastAppliedCursor = default;
_lastStandardCursor = desired;
}
private bool TryGetImage(uint renderSurfaceId, out RawImage image)
{
if (_imagesBySurface.TryGetValue(renderSurfaceId, out image))
return true;
if (_missingSurfaces.Contains(renderSurfaceId))
return false;
DecodedTexture? decoded = DecodeCursorSurface(renderSurfaceId);
if (decoded is null || decoded.Width <= 0 || decoded.Height <= 0 || decoded.Rgba8.Length == 0)
{
_missingSurfaces.Add(renderSurfaceId);
image = default;
return false;
}
image = new RawImage(decoded.Width, decoded.Height, decoded.Rgba8);
_imagesBySurface[renderSurfaceId] = image;
return true;
}
private DecodedTexture? DecodeCursorSurface(uint renderSurfaceId)
{
lock (_datLock)
{
if (!_dats.Portal.TryGet<RenderSurface>(renderSurfaceId, out var rs)
&& !_dats.HighRes.TryGet<RenderSurface>(renderSurfaceId, out rs))
return null;
Palette? palette = rs.DefaultPaletteId != 0
? _dats.Get<Palette>(rs.DefaultPaletteId)
: null;
return SurfaceDecoder.DecodeRenderSurface(rs, palette);
}
}
internal static IReadOnlyList<RetailCursorLayer> PlanApplication(
bool hasLayerState,
RetailGlobalCursorKind previousGlobal,
UiCursorMedia previousWidget,
RetailGlobalCursorKind currentGlobal,
UiCursorMedia currentWidget)
{
bool globalChanged = !hasLayerState || previousGlobal != currentGlobal;
bool widgetChanged = !hasLayerState || previousWidget != currentWidget;
if (!globalChanged && !widgetChanged)
return Array.Empty<RetailCursorLayer>();
var result = new List<RetailCursorLayer>(2);
if (globalChanged)
result.Add(RetailCursorLayer.Global);
if (widgetChanged)
{
RetailCursorLayer widgetResult = currentWidget.IsValid
? RetailCursorLayer.Widget
: RetailCursorLayer.Global;
if (result.Count == 0 || result[^1] != widgetResult)
result.Add(widgetResult);
}
return result;
}
private static StandardCursor StandardCursorFor(RetailGlobalCursorKind kind)
=> kind switch
{
RetailGlobalCursorKind.Use or RetailGlobalCursorKind.UseFound => StandardCursor.Hand,
RetailGlobalCursorKind.TargetPending => StandardCursor.Crosshair,
RetailGlobalCursorKind.TargetValid => StandardCursor.ResizeAll,
RetailGlobalCursorKind.TargetInvalid => StandardCursor.NotAllowed,
_ => StandardCursor.Arrow,
};
}
internal enum RetailCursorLayer
{
Global,
Widget,
}