feat(diagnostics): developer diagnostics and runtime inspection (DEBUG-1)

docs/api/MicroEngine.Audio.AudioMixer.md

@@ -133,6 +133,19 @@ public float SfxVolume { get; set; }
 
  [float](https://learn.microsoft.com/dotnet/api/system.single)
 
+### <a id="MicroEngine_Audio_AudioMixer_Statistics"></a> Statistics
+
+The voices of the device's mixer: how many sounds play now, how many can play at once and how many the voice
+policy refused so far. Zeros for a device without the engine's mixer ([SilentAudioDevice](MicroEngine.Audio.SilentAudioDevice.md)).
+
+```csharp
+public AudioStatistics Statistics { get; }
+```
+
+#### Property Value
+
+ [AudioStatistics](MicroEngine.Audio.AudioStatistics.md)
+
 ## Methods
 
 ### <a id="MicroEngine_Audio_AudioMixer_AddMusic_System_String_MicroEngine_Audio_AudioClip_System_Boolean_"></a> AddMusic\(string, AudioClip, bool\)

docs/api/MicroEngine.Audio.AudioStatistics.md

@@ -0,0 +1,179 @@
+# Struct AudioStatistics
+
+<div data-pagefind-weight="0.3">
+
+Namespace: [MicroEngine.Audio](MicroEngine.Audio.md)  
+Assembly: MicroEngine.Audio.dll  
+Guide: [Audio](../manual/audio.md)  
+
+What [Statistics](MicroEngine.Audio.AudioMixer.md#MicroEngine_Audio_AudioMixer_Statistics) reports about the mixer's voices.
+
+```csharp
+public readonly struct AudioStatistics : IEquatable<AudioStatistics>
+```
+
+#### Implements
+
+[IEquatable<AudioStatistics\>](https://learn.microsoft.com/dotnet/api/system.iequatable\-1)
+
+## Constructors
+
+### <a id="MicroEngine_Audio_AudioStatistics__ctor_System_Int32_System_Int32_System_Int32_"></a> AudioStatistics\(int, int, int\)
+
+What [Statistics](MicroEngine.Audio.AudioMixer.md#MicroEngine_Audio_AudioMixer_Statistics) reports about the mixer's voices.
+
+```csharp
+public AudioStatistics(int ActiveVoices, int MaxVoices, int RefusedSounds)
+```
+
+#### Parameters
+
+`ActiveVoices` [int](https://learn.microsoft.com/dotnet/api/system.int32)
+
+Sounds playing now, music included.
+
+`MaxVoices` [int](https://learn.microsoft.com/dotnet/api/system.int32)
+
+Sounds that can play at once.
+
+`RefusedSounds` [int](https://learn.microsoft.com/dotnet/api/system.int32)
+
+Sounds the voice policy refused since the start because every voice played something of higher priority.
+
+## Properties
+
+### <a id="MicroEngine_Audio_AudioStatistics_ActiveVoices"></a> ActiveVoices
+
+Sounds playing now, music included.
+
+```csharp
+public int ActiveVoices { get; init; }
+```
+
+#### Property Value
+
+ [int](https://learn.microsoft.com/dotnet/api/system.int32)
+
+### <a id="MicroEngine_Audio_AudioStatistics_MaxVoices"></a> MaxVoices
+
+Sounds that can play at once.
+
+```csharp
+public int MaxVoices { get; init; }
+```
+
+#### Property Value
+
+ [int](https://learn.microsoft.com/dotnet/api/system.int32)
+
+### <a id="MicroEngine_Audio_AudioStatistics_RefusedSounds"></a> RefusedSounds
+
+Sounds the voice policy refused since the start because every voice played something of higher priority.
+
+```csharp
+public int RefusedSounds { get; init; }
+```
+
+#### Property Value
+
+ [int](https://learn.microsoft.com/dotnet/api/system.int32)
+
+## Methods
+
+### <a id="MicroEngine_Audio_AudioStatistics_Deconstruct_System_Int32__System_Int32__System_Int32__"></a> Deconstruct\(out int, out int, out int\)
+
+```csharp
+public void Deconstruct(out int ActiveVoices, out int MaxVoices, out int RefusedSounds)
+```
+
+#### Parameters
+
+`ActiveVoices` [int](https://learn.microsoft.com/dotnet/api/system.int32)
+
+`MaxVoices` [int](https://learn.microsoft.com/dotnet/api/system.int32)
+
+`RefusedSounds` [int](https://learn.microsoft.com/dotnet/api/system.int32)
+
+### <a id="MicroEngine_Audio_AudioStatistics_Equals_System_Object_"></a> Equals\(object\)
+
+```csharp
+public override bool Equals(object obj)
+```
+
+#### Parameters
+
+`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)
+
+#### Returns
+
+ [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
+
+### <a id="MicroEngine_Audio_AudioStatistics_Equals_MicroEngine_Audio_AudioStatistics_"></a> Equals\(AudioStatistics\)
+
+```csharp
+public bool Equals(AudioStatistics other)
+```
+
+#### Parameters
+
+`other` [AudioStatistics](MicroEngine.Audio.AudioStatistics.md)
+
+#### Returns
+
+ [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
+
+### <a id="MicroEngine_Audio_AudioStatistics_GetHashCode"></a> GetHashCode\(\)
+
+```csharp
+public override int GetHashCode()
+```
+
+#### Returns
+
+ [int](https://learn.microsoft.com/dotnet/api/system.int32)
+
+### <a id="MicroEngine_Audio_AudioStatistics_ToString"></a> ToString\(\)
+
+```csharp
+public override string ToString()
+```
+
+#### Returns
+
+ [string](https://learn.microsoft.com/dotnet/api/system.string)
+
+## Operators
+
+### <a id="MicroEngine_Audio_AudioStatistics_op_Equality_MicroEngine_Audio_AudioStatistics_MicroEngine_Audio_AudioStatistics_"></a> operator ==\(AudioStatistics, AudioStatistics\)
+
+```csharp
+public static bool operator ==(AudioStatistics left, AudioStatistics right)
+```
+
+#### Parameters
+
+`left` [AudioStatistics](MicroEngine.Audio.AudioStatistics.md)
+
+`right` [AudioStatistics](MicroEngine.Audio.AudioStatistics.md)
+
+#### Returns
+
+ [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
+
+### <a id="MicroEngine_Audio_AudioStatistics_op_Inequality_MicroEngine_Audio_AudioStatistics_MicroEngine_Audio_AudioStatistics_"></a> operator \!=\(AudioStatistics, AudioStatistics\)
+
+```csharp
+public static bool operator !=(AudioStatistics left, AudioStatistics right)
+```
+
+#### Parameters
+
+`left` [AudioStatistics](MicroEngine.Audio.AudioStatistics.md)
+
+`right` [AudioStatistics](MicroEngine.Audio.AudioStatistics.md)
+
+#### Returns
+
+ [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
+
+</div>

docs/api/MicroEngine.Audio.md

@@ -80,6 +80,10 @@ An opaque handle to a loaded sound effect.
 
 ### Structs
 
+ [AudioStatistics](MicroEngine.Audio.AudioStatistics.md)
+
+What [Statistics](MicroEngine.Audio.AudioMixer.md#MicroEngine_Audio_AudioMixer_Statistics) reports about the mixer's voices.
+
  [PlayParameters](MicroEngine.Audio.PlayParameters.md)
 
 How a sound plays.

docs/api/MicroEngine.Core.CrashReport.md

@@ -0,0 +1,83 @@
+# Class CrashReport
+
+<div data-pagefind-weight="0.3">
+
+Namespace: [MicroEngine.Core](MicroEngine.Core.md)  
+Assembly: MicroEngine.dll  
+Guide: [Game lifecycle and time](../manual/lifecycle.md)  
+
+A text file that describes a run that stopped on an error, for a tester to send: the game and engine versions, the
+operating system and runtime, the platform's facts ([IPlatformDiagnostics](MicroEngine.Core.IPlatformDiagnostics.md)), the last measured frame and
+its slowest systems when [Diagnostics](MicroEngine.Core.Game.md#MicroEngine_Core_Game_Diagnostics) measured, and the error with its stack trace. The desktop
+launcher writes one when a game's run fails and names it on standard error.
+
+```csharp
+public static class CrashReport
+```
+
+#### Inheritance
+
+[object](https://learn.microsoft.com/dotnet/api/system.object) ← 
+[CrashReport](MicroEngine.Core.CrashReport.md)
+
+## Methods
+
+### <a id="MicroEngine_Core_CrashReport_Describe_MicroEngine_Core_Game_System_Exception_"></a> Describe\(Game, Exception\)
+
+The report's text for <code class="paramref">error</code>, which stopped <code class="paramref">game</code>.
+
+```csharp
+public static string Describe(Game game, Exception error)
+```
+
+#### Parameters
+
+`game` [Game](MicroEngine.Core.Game.md)
+
+`error` [Exception](https://learn.microsoft.com/dotnet/api/system.exception)
+
+#### Returns
+
+ [string](https://learn.microsoft.com/dotnet/api/system.string)
+
+#### Exceptions
+
+ [ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
+
+An argument is null.
+
+### <a id="MicroEngine_Core_CrashReport_Write_MicroEngine_Core_Game_System_Exception_System_String_"></a> Write\(Game, Exception, string\)
+
+Writes the report into <code class="paramref">directory</code> (created if needed) as <code>crash-&lt;UTC time&gt;.txt</code> and returns its path.
+
+```csharp
+public static string Write(Game game, Exception error, string directory)
+```
+
+#### Parameters
+
+`game` [Game](MicroEngine.Core.Game.md)
+
+`error` [Exception](https://learn.microsoft.com/dotnet/api/system.exception)
+
+`directory` [string](https://learn.microsoft.com/dotnet/api/system.string)
+
+#### Returns
+
+ [string](https://learn.microsoft.com/dotnet/api/system.string)
+
+#### Exceptions
+
+ [ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
+
+An argument is null.
+
+ [IOException](https://learn.microsoft.com/dotnet/api/system.io.ioexception)
+
+The file cannot be written.
+
+ [UnauthorizedAccessException](https://learn.microsoft.com/dotnet/api/system.unauthorizedaccessexception)
+
+The folder is not writable.
+
+</div>

docs/api/MicroEngine.Core.DebugDraw.PhysicsColors.md

@@ -0,0 +1,94 @@
+# Class DebugDraw.PhysicsColors
+
+<div data-pagefind-weight="0.3">
+
+Namespace: [MicroEngine.Core](MicroEngine.Core.md)  
+Assembly: MicroEngine.dll  
+Guide: [Game lifecycle and time](../manual/lifecycle.md)  
+
+The colours [Physics](MicroEngine.Core.DebugDraw.md#MicroEngine_Core_DebugDraw_Physics_MicroEngine_Physics_IPhysicsWorld2D_System_Nullable_MicroEngine_RectF__) uses.
+
+```csharp
+public static class DebugDraw.PhysicsColors
+```
+
+#### Inheritance
+
+[object](https://learn.microsoft.com/dotnet/api/system.object) ← 
+[DebugDraw.PhysicsColors](MicroEngine.Core.DebugDraw.PhysicsColors.md)
+
+## Fields
+
+### <a id="MicroEngine_Core_DebugDraw_PhysicsColors_Contact"></a> Contact
+
+Contacts that began during the latest step: the normal from the first shape's body.
+
+```csharp
+public static readonly Color Contact
+```
+
+#### Field Value
+
+ [Color](MicroEngine.Color.md)
+
+### <a id="MicroEngine_Core_DebugDraw_PhysicsColors_Dynamic"></a> Dynamic
+
+Shapes of dynamic bodies.
+
+```csharp
+public static readonly Color Dynamic
+```
+
+#### Field Value
+
+ [Color](MicroEngine.Color.md)
+
+### <a id="MicroEngine_Core_DebugDraw_PhysicsColors_Kinematic"></a> Kinematic
+
+Shapes of kinematic bodies.
+
+```csharp
+public static readonly Color Kinematic
+```
+
+#### Field Value
+
+ [Color](MicroEngine.Color.md)
+
+### <a id="MicroEngine_Core_DebugDraw_PhysicsColors_OneWay"></a> OneWay
+
+One-way shapes and one-way tiles.
+
+```csharp
+public static readonly Color OneWay
+```
+
+#### Field Value
+
+ [Color](MicroEngine.Color.md)
+
+### <a id="MicroEngine_Core_DebugDraw_PhysicsColors_Sensor"></a> Sensor
+
+Sensors.
+
+```csharp
+public static readonly Color Sensor
+```
+
+#### Field Value
+
+ [Color](MicroEngine.Color.md)
+
+### <a id="MicroEngine_Core_DebugDraw_PhysicsColors_Static"></a> Static
+
+Shapes of static bodies.
+
+```csharp
+public static readonly Color Static
+```
+
+#### Field Value
+
+ [Color](MicroEngine.Color.md)
+
+</div>