feat(render): Campaign V slice V4a - port TextRenderer/BitmapFont/DebugLineRenderer/TextureCache onto IGpuDevice
TextRenderer, BitmapFont, DebugLineRenderer, and TextureCache's UI-texture
upload path (GetOrUploadRenderSurface/UploadRgba8) now issue every draw and
resource creation through the pinned IGpuDevice/IGpuFrame/IGpuPassEncoder
RHI contract instead of raw GL. This is the RHI's first real production
consumer - V0-V3 only established the contract, GL backend skeleton, and a
shader-dialect migration with no live GL exercise. TextRenderer owns one
IGpuPipeline (ui_text shader, straight-alpha blend, depth disabled) and
allocates a per-bucket ring each Flush; BitmapFont's atlas texture is
created and uploaded via device.CreateTexture/.Upload; DebugLineRenderer
mirrors the same one-pipeline-per-Flush shape for its line-list draws.
World-path TextureCache methods (GetOrUpload, the raw-GL layer-array
upload) are untouched - still legacy GL, still out of scope.
Frame lifecycle: GpuDeviceFrameLifetime (RenderFrameOrchestrator.cs) wraps
IGpuDevice.BeginFrame()/IGpuFrame.End() inside the existing
IRenderFrameLifetime bracket HostInputCameraCompositionPhase already opens
per callback, additively - no frame-graph restructuring. Ported renderers
reach the frame via ICurrentGpuFrameSource, a plain interface (not a
delegate field) so WorldSceneDiagnosticsController keeps passing its
existing "no stored window/delegate" architectural-conformance test.
Two real bugs surfaced by actually exercising the RHI against a live GL
context (nothing here was previously reachable before this slice):
- GlGpuDevice.BeginFrame() now resets the render-state cache every frame.
The cache assumes it is the sole writer of GL program/blend/depth/cull
state, which was true while it had zero real consumers, but every
still-legacy renderer (WbDrawDispatcher, terrain, particles, EnvCells)
mutates that same GL state directly and never informs the cache. Once a
legacy renderer ran between two RHI binds, the cache's belief about the
current GL program went stale, so a later BindPipeline(text shader)
skipped re-issuing glUseProgram and the following push-constant upload
threw GL_INVALID_OPERATION against whatever program was actually bound.
Reset() at the frame boundary is the same defensive move BeginPass
already makes after a forced clear (see its comment); it costs one
redundant state application on the frame's first bind.
- GL_MULTISAMPLE has no representation in the pinned contract. Added a
GL-backend-internal Multisample field to GlRenderStateSnapshot/Changes,
computed from GpuPipelineDescription.SampleCount at BindPipeline time -
mirrors how Vulkan bakes MSAA into the pipeline instead of a separate
toggle.
Collateral, scoped to keep the port real rather than a stub:
- GpuTextureSlot (Unassigned = uint.MaxValue, NOT 0) now flows through
every consumer of TextureCache.GetOrUploadRenderSurface/UploadRgba8 and
TextRenderer.DrawSprite - the entire retained UI layer, since a pervasive
Func<uint,(uint,int,int)> sprite-resolve delegate threads through nearly
every UI element/controller. Every prior `== 0` / `!= 0` "no texture"
check became `.IsAssigned` / `!.IsAssigned`; slot 0 is a real assigned
slot (the device's default white texture), so the old sentinel would
have produced live visual regressions if left in place.
- GpuTextureSlot/IGpuDevice/IGpuFrame are internal, so ~270 previously
public AcDream.App types that touched them (directly or transitively)
are now internal too - safe, since AcDream.App is an exe with no
external project references; only the two test projects consume it, via
InternalsVisibleTo. A handful of unrelated types the sweep caught
(ElementInfo/ImportedLayout's property-bag hierarchy, several enums used
as public [Theory] parameters, CursorFeedbackSnapshot's DragAcceptState)
were reverted back to public where making them internal would have
either cascaded into unrelated files or broken xUnit's public-member
discovery.
- ExternalViewportTextureBridge (new) registers the still-raw-GL FBO
color textures PrivateEntityViewportRenderer/PaperdollViewportRenderer
produce (V4g's scope) into the device's texture table for
UiViewport.TextureHandle, via a temporary
GlGpuDevice.RegisterExternalColorTexture escape hatch (internal, not
part of IGpuDevice) deleted when V4g ports those viewports.
- TextRenderGlStateScope.cs and its test deleted: the pipeline description
now bakes what it used to restore by hand.
- ResourceCleanupGroupTests/GlTextureOwnershipTests: the two source-text
conformance tests keyed to TextRenderer's old multi-resource
construction shape (Shader + per-flight FrameBufferSet array + white
texture + tracked VAO/VBO, all via ResourceCleanupGroup) no longer apply
- that shape is gone, replaced by one IGpuPipeline created through
IGpuDevice. The construction-order test is deleted; the checked-commit
texture-creation check now targets GlGpuTexture (which already used
the same GlResourceCommand.CreateName primitive before this slice).
Gates:
- dotnet build -c Release: 0 warnings, 0 errors (AcDream.App has
TreatWarningsAsErrors).
- dotnet test tests/AcDream.App.Tests -c Release: 3,840 passed / 3
skipped (was 3,843/3 entering this slice - net 3 fewer tests:
TextRendererFailureSafetyTests.cs deleted (2, tested the now-deleted
TextRenderGlStateScope) plus the one retired ResourceCleanupGroupTests
method). Full solution: 8,908 passed / 5 skipped across all nine test
projects.
- Offline pixel gate (tools/run-offline-pixel-gate.ps1, parent ec414d60
vs this commit): differing fraction 0.318% (1,791/563,200 compared
pixels), above the 0.001 threshold. Investigated pixel-by-pixel rather
than waved through: a diff heatmap plus 4x crops at the differing
clusters show zero differences anywhere in the retained UI, terrain,
scenery, or static meshes - every differing pixel sits on continuously-
animated ambient content (flying-insect sprites over the swamp, foliage
sparkle/dew glints) whose exact phase depends on elapsed wall-clock
time, the same category the gate's own sky-masking rationale already
documents and the campaign doc's coverage table explicitly excludes
("Not covered - particles"). Confirming evidence: two same-commit
captures at HEAD compare clean against each other (0.0025%), and two
same-commit captures at the parent compare clean against each other
(0.0044%) - only base-vs-head is consistently elevated, which is what
frame-pacing drift from genuinely new per-frame RHI work (BeginFrame,
ring resets, the render-state reset above) would produce against a
fixed wall-clock capture deadline, not a rendering defect. Recommend a
quick user visual check of this capture pair alongside the automated
result, matching how V2c's particle work was already handled in this
campaign (flagged for user visual confirmation rather than blocked on
an automated gate that cannot cover animated content).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Erik
parent
ec414d60cd
commit
ceec3bc440
334 changed files with 3660 additions and 3840 deletions
|
|
@ -1,4 +1,4 @@
|
|||
using System;
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Numerics;
|
||||
using AcDream.Core.Audio;
|
||||
|
|
@ -7,8 +7,8 @@ using Silk.NET.OpenAL;
|
|||
namespace AcDream.App.Audio;
|
||||
|
||||
/// <summary>
|
||||
/// OpenAL-backed audio engine (Phase E.2) — faithful to retail's
|
||||
/// 16-voice pool and inverse-square falloff behaviour (r05 §5.3).
|
||||
/// OpenAL-backed audio engine (Phase E.2) — faithful to retail's
|
||||
/// 16-voice pool and inverse-square falloff behaviour (r05 §5.3).
|
||||
///
|
||||
/// <para>
|
||||
/// Architecture:
|
||||
|
|
@ -16,7 +16,7 @@ namespace AcDream.App.Audio;
|
|||
/// <item><description>
|
||||
/// Single <see cref="ALContext"/> + <see cref="AL"/> bound to the
|
||||
/// system default device. Cross-platform (WASAPI / WinMM /
|
||||
/// PulseAudio / CoreAudio — whichever OpenAL-Soft picks).
|
||||
/// PulseAudio / CoreAudio — whichever OpenAL-Soft picks).
|
||||
/// </description></item>
|
||||
/// <item><description>
|
||||
/// Fixed 16-source pool for 3D positional sounds. When all 16 are
|
||||
|
|
@ -27,13 +27,13 @@ namespace AcDream.App.Audio;
|
|||
/// </description></item>
|
||||
/// <item><description>
|
||||
/// Separate UI source pool (4 sources) for flat 2D UI clicks /
|
||||
/// wooshes — not subject to the 3D eviction game.
|
||||
/// wooshes — not subject to the 3D eviction game.
|
||||
/// </description></item>
|
||||
/// <item><description>
|
||||
/// PCM buffer cache keyed by Wave dat id so the same footstep isn't
|
||||
/// re-uploaded to the GL-equivalent AL buffers on every hit. Bounded
|
||||
/// by a byte budget (<see cref="DefaultBufferByteBudget"/>) enforced
|
||||
/// with LRU eviction — see <see cref="EvictBuffersOverBudget"/>. A
|
||||
/// with LRU eviction — see <see cref="EvictBuffersOverBudget"/>. A
|
||||
/// buffer still attached to a live source is never evicted (AL
|
||||
/// rejects deleting a bound buffer); eviction re-queries live AL
|
||||
/// source state rather than tracking a second copy of it.
|
||||
|
|
@ -60,15 +60,15 @@ internal interface IWorldAudioQuiescence
|
|||
void ResumeWorldAudio();
|
||||
}
|
||||
|
||||
public sealed unsafe class OpenAlAudioEngine : IAudioEngine, IWorldAudioQuiescence
|
||||
internal sealed unsafe class OpenAlAudioEngine : IAudioEngine, IWorldAudioQuiescence
|
||||
{
|
||||
// ── Backends ─────────────────────────────────────────────────────────────
|
||||
// ── Backends ─────────────────────────────────────────────────────────────
|
||||
private AL? _al;
|
||||
private OpenAlResourceLifetime? _resources;
|
||||
private bool _available;
|
||||
private bool _disposed;
|
||||
|
||||
// ── Pools ────────────────────────────────────────────────────────────────
|
||||
// ── Pools ────────────────────────────────────────────────────────────────
|
||||
private const int PoolSize3D = 16; // retail 16-slot voice pool
|
||||
private const int PoolSizeUi = 4;
|
||||
|
||||
|
|
@ -88,7 +88,7 @@ public sealed unsafe class OpenAlAudioEngine : IAudioEngine, IWorldAudioQuiescen
|
|||
|
||||
private readonly uint[] _poolUi = new uint[PoolSizeUi];
|
||||
|
||||
// ── Buffer cache (Wave dat id → AL buffer) ───────────────────────────────
|
||||
// ── Buffer cache (Wave dat id → AL buffer) ───────────────────────────────
|
||||
// Budget rationale: decoded PCM waves run ~100-500 KB each (same sizing
|
||||
// as DatSoundCache's payload LRU, which this cache re-uploads from). 48
|
||||
// MiB gives comfortable headroom for the working set of a play session
|
||||
|
|
@ -99,11 +99,11 @@ public sealed unsafe class OpenAlAudioEngine : IAudioEngine, IWorldAudioQuiescen
|
|||
private readonly Dictionary<uint, uint> _bufferByWaveId = new();
|
||||
private readonly AlBufferBudgetTracker _bufferBudget = new(DefaultBufferByteBudget);
|
||||
|
||||
// ── Ambient handles (StartAmbient/StopAmbient) ───────────────────────────
|
||||
// ── Ambient handles (StartAmbient/StopAmbient) ───────────────────────────
|
||||
private readonly Dictionary<int, uint> _ambientSources = new();
|
||||
private int _nextAmbientHandle = 1;
|
||||
|
||||
// ── Public volume knobs ──────────────────────────────────────────────────
|
||||
// ── Public volume knobs ──────────────────────────────────────────────────
|
||||
public float MasterVolume { get; set; } = 1f;
|
||||
public float SfxVolume { get; set; } = 1f;
|
||||
public float MusicVolume { get; set; } = 0.7f;
|
||||
|
|
@ -219,7 +219,7 @@ public sealed unsafe class OpenAlAudioEngine : IAudioEngine, IWorldAudioQuiescen
|
|||
_al = null;
|
||||
}
|
||||
|
||||
// ── IAudioEngine ─────────────────────────────────────────────────────────
|
||||
// ── IAudioEngine ─────────────────────────────────────────────────────────
|
||||
|
||||
public void SetListener(
|
||||
float posX, float posY, float posZ,
|
||||
|
|
@ -241,7 +241,7 @@ public sealed unsafe class OpenAlAudioEngine : IAudioEngine, IWorldAudioQuiescen
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Not exposed on IAudioEngine but used by the hook sink — play a raw
|
||||
/// Not exposed on IAudioEngine but used by the hook sink — play a raw
|
||||
/// WaveData blob at a 3D position with full priority/volume controls.
|
||||
/// Returns true on success, false if the buffer was rejected.
|
||||
/// </summary>
|
||||
|
|
@ -278,7 +278,7 @@ public sealed unsafe class OpenAlAudioEngine : IAudioEngine, IWorldAudioQuiescen
|
|||
if (_pool3D[idx].PlayingGain < effectiveGain) { slotIdx = idx; break; }
|
||||
}
|
||||
}
|
||||
if (slotIdx < 0) return false; // no slot quieter than us — drop
|
||||
if (slotIdx < 0) return false; // no slot quieter than us — drop
|
||||
|
||||
var slot = _pool3D[slotIdx];
|
||||
_al.SourceStop(slot.SourceId);
|
||||
|
|
@ -355,7 +355,7 @@ public sealed unsafe class OpenAlAudioEngine : IAudioEngine, IWorldAudioQuiescen
|
|||
return true;
|
||||
}
|
||||
|
||||
// IAudioEngine implementations — the enum-based overloads are less
|
||||
// IAudioEngine implementations — the enum-based overloads are less
|
||||
// useful than the raw-Wave overloads above, since the hook sink already
|
||||
// has access to decoded WaveData. Left as no-ops for now; R5 defines
|
||||
// SoundId as a sparse subset of retail enums.
|
||||
|
|
@ -366,7 +366,7 @@ public sealed unsafe class OpenAlAudioEngine : IAudioEngine, IWorldAudioQuiescen
|
|||
|
||||
public int StartAmbient(SoundId id, float x, float y, float z)
|
||||
{
|
||||
// Looping ambient — needs a decoded wave + WaveId. The hook sink
|
||||
// Looping ambient — needs a decoded wave + WaveId. The hook sink
|
||||
// doesn't route ambient; a separate landblock-attached ambient
|
||||
// system (outside R5) will drive this. For now: reserve a handle.
|
||||
int handle = _nextAmbientHandle++;
|
||||
|
|
@ -383,17 +383,17 @@ public sealed unsafe class OpenAlAudioEngine : IAudioEngine, IWorldAudioQuiescen
|
|||
}
|
||||
}
|
||||
|
||||
public void PlayMusic(string resourceName, bool loop) { /* R5 §6 MIDI — not ported */ }
|
||||
public void PlayMusic(string resourceName, bool loop) { /* R5 §6 MIDI — not ported */ }
|
||||
public void StopMusic() { /* ditto */ }
|
||||
|
||||
// ── Private helpers ──────────────────────────────────────────────────────
|
||||
// ── Private helpers ──────────────────────────────────────────────────────
|
||||
|
||||
private uint EnsureBuffer(uint waveId, WaveData wave)
|
||||
{
|
||||
if (!_available || _al is null) return 0;
|
||||
if (_bufferByWaveId.TryGetValue(waveId, out var existing))
|
||||
{
|
||||
// Buffer id 0 is the "unsupported format" negative marker — no
|
||||
// Buffer id 0 is the "unsupported format" negative marker — no
|
||||
// payload, not tracked by the budget, nothing to touch.
|
||||
if (existing != 0)
|
||||
_bufferBudget.Touch(waveId);
|
||||
|
|
@ -425,15 +425,15 @@ public sealed unsafe class OpenAlAudioEngine : IAudioEngine, IWorldAudioQuiescen
|
|||
/// <summary>
|
||||
/// Evict least-recently-used AL buffers until the resident-byte budget
|
||||
/// is satisfied again. A buffer still bound to a live source (3D pool,
|
||||
/// UI pool, or an ambient source) is protected — <c>alDeleteBuffers</c>
|
||||
/// fails on a buffer that's still attached to a source — so eviction
|
||||
/// UI pool, or an ambient source) is protected — <c>alDeleteBuffers</c>
|
||||
/// fails on a buffer that's still attached to a source — so eviction
|
||||
/// never targets one; nor does it target <paramref name="protectedBufferId"/>,
|
||||
/// the buffer <see cref="EnsureBuffer"/> just created for this call and
|
||||
/// hasn't attached to a source yet. If every resident buffer is
|
||||
/// protected the budget is temporarily exceeded rather than looping
|
||||
/// forever; the bounded pool sizes (16 + 4 + ambient) cap how large
|
||||
/// that overage can get. Evicted waves replay through
|
||||
/// <see cref="EnsureBuffer"/> again on next use — re-upload from
|
||||
/// <see cref="EnsureBuffer"/> again on next use — re-upload from
|
||||
/// <see cref="DatSoundCache"/>, identical to a first play.
|
||||
/// </summary>
|
||||
private void EvictBuffersOverBudget(uint protectedBufferId)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue