Clarify the meaning of PULSE_OFFSET

Quite obvious, if you look at the code, that this is not a used value. Not sure why it exists like that, which doesn't match other reserved ranges. But eh, gotta live with it now.
YuriSizov · Oct 24, 2024 · 9789273 · 9789273
1 parent ab5139a
commit 9789273
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/doc_classes/SiONDriver.xml b/doc_classes/SiONDriver.xml
@@ -636,7 +636,7 @@
 			High frequency pseudo sync pulse generator.
 		</constant>
 		<constant name="PULSE_OFFSET" value="10" enum="SiONPulseGeneratorType">
-			Offset pulse generator.
+			Reserved value.
 		</constant>
 		<constant name="PULSE_SAW_VC6" value="11" enum="SiONPulseGeneratorType">
 			VC6 saw pulse generator (32-sample saw).

diff --git a/src/sion_enums.h b/src/sion_enums.h
@@ -70,7 +70,7 @@ enum SiONPulseGeneratorType : int {
 	PULSE_KNM_BUBBLE		= 7,    // Konami bubble system wave.
 	PULSE_SYNC_LOW			= 8,    // pseudo sync (low frequency).
 	PULSE_SYNC_HIGH			= 9,    // pseudo sync (high frequency).
-	PULSE_OFFSET			= 10,   // offset.
+	PULSE_OFFSET			= 10,   // reserved value, unused.
 	PULSE_SAW_VC6			= 11,   // VC6 saw (32-sample saw).
 									// ( 12- 15) reserved.