Add a comment describing the format

maxim-zhao · Nov 16, 2024 · 8865c6a · 8865c6a
1 parent 9233c8b
commit 8865c6a
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/compressors/gfxcomp_wbmw.cpp b/compressors/gfxcomp_wbmw.cpp
@@ -5,6 +5,13 @@
 #include "utils.h"
 #include "rle.h"
 
+// Compression format:
+// - Data is processed one bitplane at a time
+// - For each bitplane:
+//   - %0nnnnnnn = RLE run of n bytes, 1<=n<=127
+//   - %1nnnnnnn = raw run of n bytes (byte is negated count), 1<=n<=128
+//   - %00000000 = end of bitplane
+
 void compressPlane(
     std::vector<uint8_t>& destination,
     const std::vector<uint8_t>::const_iterator& source,