Effects: document new effect chain controls

source/chapters/appendix/changelog.rst

@@ -460,7 +460,7 @@ Controller Backend
 * Log warning if deprecated control is used `#11972 <https://github.com/mixxxdj/mixxx/pull/11972>`__
 * ControlObject alias improvements `#11973 <https://github.com/mixxxdj/mixxx/pull/11973>`__
 * Keyboard: Repeat certain control actions if key is held `#12474 <https://github.com/mixxxdj/mixxx/pull/12474>`__
-* Keyboard mapping: Return triggers doubleclick, move Preview functions to P / Shift+P `#12639 <https://github.com/mixxxdj/mixxx/pull/12639>`__
+* Keyboard mapping: Return triggers double-click, move Preview functions to P / Shift+P `#12639 <https://github.com/mixxxdj/mixxx/pull/12639>`__
 * Update keyboard sheet `#12578 <https://github.com/mixxxdj/mixxx/pull/12578>`__
 * Logging: Add support for ``QT_MESSAGE_PATTERN`` environment variable
   `#3204 <https://github.com/mixxxdj/mixxx/pull/3204>`__

source/chapters/appendix/mixxx_controls.rst

@@ -3673,18 +3673,9 @@ Controls
    :range: integer, read-only
 
 
-.. mixxx:control:: [EffectRack1],clear
-                   [EqualizerRack1],clear
-                   [QuickEffectRack1],clear
-
-   Clear the Effect Rack
-
-   :range: binary
-
-
-.. mixxx:control:: [EffectRack1_EffectUnitN],chain_selector
-                   [EqualizerRack1_[ChannelI]],chain_selector
-                   [QuickEffectRack1_[ChannelI]],chain_selector
+.. mixxx:control:: [EffectRack1_EffectUnitN],chain_preset_selector
+                   [EqualizerRack1_[ChannelI]],chain_preset_selector
+                   [QuickEffectRack1_[ChannelI]],chain_preset_selector
 
    Select EffectChain preset. \> 0 goes one forward; \< 0 goes one backward.
 
@@ -3757,6 +3748,16 @@ Controls
    :range: binary, read-only
 
 
+.. mixxx:control:: [EffectRack1_EffectUnitN],loaded_chain_preset
+                   [EqualizerRack1_[ChannelI]],loaded_chain_preset
+                   [QuickEffectRack1_[ChannelI]],loaded_chain_preset
+
+   0-based index of the currently loaded EffectChain preset. `0` is the empty/passthrough
+   preset, `-1` indicates an unsaved preset (default state of `[EffectRack1_EffectUnitN]`).
+
+   :range: integer, 0 .. [:mixxx:coref:`num_chain_presets<[EffectRack1_EffectUnitN],num_chain_presets>` - 1]
+
+
 .. mixxx:control:: [EffectRack1_EffectUnitN],mix
                    [EqualizerRack1_[ChannelI]],mix
                    [QuickEffectRack1_[ChannelI]],mix
@@ -3768,15 +3769,25 @@ Controls
    :range: 0.0..1.0
 
 
-.. mixxx:control:: [EffectRack1_EffectUnitN],next_chain
-                   [EqualizerRack1_[ChannelI]],next_chain
-                   [QuickEffectRack1_[ChannelI]],next_chain
+.. mixxx:control:: [EffectRack1_EffectUnitN],next_chain_preset
+                   [EqualizerRack1_[ChannelI]],next_chain_preset
+                   [QuickEffectRack1_[ChannelI]],next_chain_preset
 
    Cycle to the next EffectChain preset after the currently loaded preset.
 
    :range: binary
 
 
+.. mixxx:control:: [EffectRack1_EffectUnitN],num_chain_presets
+                   [EqualizerRack1_[ChannelI]],num_chain_presets
+                   [QuickEffectRack1_[ChannelI]],num_chain_presets
+
+   The number of effect chain presets available in this EffectUnit, including the
+   empty/passthrough preset "---".
+
+   :range: integer, read-only
+
+
 .. mixxx:control:: [EffectRack1_EffectUnitN],num_effectslots
                    [EqualizerRack1_[ChannelI]],num_effectslots
                    [QuickEffectRack1_[ChannelI]],num_effectslots
@@ -3786,9 +3797,9 @@ Controls
    :range: integer, read-only
 
 
-.. mixxx:control:: [EffectRack1_EffectUnitN],prev_chain
-                   [EqualizerRack1_[ChannelI]],prev_chain
-                   [QuickEffectRack1_[ChannelI]],prev_chain
+.. mixxx:control:: [EffectRack1_EffectUnitN],prev_chain_preset
+                   [EqualizerRack1_[ChannelI]],prev_chain_preset
+                   [QuickEffectRack1_[ChannelI]],prev_chain_preset
 
    Cycle to the previous EffectChain preset before the currently loaded preset.
 
@@ -4531,6 +4542,41 @@ In the meantime, skins and controller mappings that still use them will keep wor
        Use :mixxx:coref:`[Library],MoveUp` instead.
 
 
+.. mixxx:control:: [EffectRack1_EffectUnitN],next_chain
+                   [EqualizerRack1_[ChannelI]],next_chain
+                   [QuickEffectRack1_[ChannelI]],next_chain
+    :range: binary
+
+    Cycle to the next EffectChain preset after the currently loaded preset.
+
+    .. deprecated:: 2.4.0
+       Use :mixxx:coref:`[EffectRack1_EffectUnitN],next_chain_preset` instead.
+
+
+.. mixxx:control:: [EffectRack1_EffectUnitN],prev_chain
+                   [EqualizerRack1_[ChannelI]],prev_chain
+                   [QuickEffectRack1_[ChannelI]],prev_chain
+    :range: binary
+
+    Cycle to the next EffectChain preset after the currently loaded preset.
+
+    .. deprecated:: 2.4.0
+       Use :mixxx:coref:`[EffectRack1_EffectUnitN],prev_chain_preset` instead.
+
+
+.. mixxx:control:: [EffectRack1_EffectUnitN],chain_selector
+                   [EqualizerRack1_[ChannelI]],chain_selector
+                   [QuickEffectRack1_[ChannelI]],chain_selector
+    :range: +1/-1
+
+    Select EffectChain preset. \> 0 goes one forward; \< 0 goes one backward.
+
+    .. deprecated:: 2.4.0
+       Use :mixxx:coref:`[EffectRack1_EffectUnitN],chain_preset_selector` instead.
+
+
+
+
 Removed controls
 ~~~~~~~~~~~~~~~~
 
@@ -4613,3 +4659,14 @@ These controls have been removed from Mixxx. Skins and controller mappings that
 
     .. deprecated:: 2.0.0
        This control has been **removed** without a direct replacement. Use the :ref:`effects framework <appendix-mixxxcontrols-effects>` instead.
+
+
+.. mixxx:control:: [EffectRack1],clear
+                   [EqualizerRack1],clear
+                   [QuickEffectRack1],clear
+    :range: binary
+
+    Clear the Effect Rack
+
+    .. deprecated:: 2.4.0
+       This control has been **removed** without a direct replacement. Use the :ref:`effects framework <appendix-mixxxcontrols-effects>` instead.