summaryrefslogtreecommitdiffstats
path: root/Tools/CompressShaders
diff options
context:
space:
mode:
authorKonstantin <const@const.me>2023-01-16 20:50:27 +0100
committerKonstantin <const@const.me>2023-01-16 20:50:27 +0100
commit8a1b4ec398e25ecc15596f830f757d8419728296 (patch)
tree2c7d1355df52d3e59d397e56b7621f1402032af4 /Tools/CompressShaders
parentaaeab774c3c8e30b2925620fc3d2a34e5f53be4c (diff)
Minor, documentation
Diffstat (limited to 'Tools/CompressShaders')
-rw-r--r--Tools/CompressShaders/Cabinet.cs1
1 files changed, 1 insertions, 0 deletions
diff --git a/Tools/CompressShaders/Cabinet.cs b/Tools/CompressShaders/Cabinet.cs
index b53fd18..313dddb 100644
--- a/Tools/CompressShaders/Cabinet.cs
+++ b/Tools/CompressShaders/Cabinet.cs
@@ -5,6 +5,7 @@ namespace CompressShaders
{
/// <summary>Lossless data compressor implemented by <c>Cabinet.dll</c> Windows component</summary>
/// <remarks>
+ /// <para>That compression API was introduced in Windows 8.0, and is the only reason why the library won’t build for Windows 7 OS.</para>
/// <para>Whisper.dll consumes that component in runtime, to decompress these shader binaries</para>
/// <para>If you wonder why not gzip — because the OS doesn’t include an API for that, at least not an API usable from C or C++.<br/>
/// .NET standard library includes gzip algorithm, but we don't want Whisper.dll to depend on .NET.</para>