From 30788baec410318bca7042a748819690ebbbbeee Mon Sep 17 00:00:00 2001
From: Jean Pierre Cimalando <jp-dev@inbox.ru>
Date: Tue, 28 Jul 2020 14:02:25 +0200
Subject: [PATCH] Add note on NXYZ indices [ci skip]

---
 src/sfizz/modulations/ModKey.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/sfizz/modulations/ModKey.h b/src/sfizz/modulations/ModKey.h
index 48977537..37b8b072 100644
--- a/src/sfizz/modulations/ModKey.h
+++ b/src/sfizz/modulations/ModKey.h
@@ -57,6 +57,8 @@ public:
             //! Parameters otherwise, based on the related opcode
             // eg. `N` in `lfoN`, `N, X` in `lfoN_eqX`
             struct { uint8_t N, X, Y, Z; };
+            // !!! NOTE: NXYZ is expected to be stored in 0-indexed form
+            //           eg. `lfo1_eq2` is N=0, X=1
         };
     };