Document the hrtf-mode config option

1 files changed, 13 insertions, 0 deletions

diff --git a/alsoftrc.sample b/alsoftrc.sample
index 95d4ff82..93f70cc1 100644
--- a/alsoftrc.sample
+++ b/alsoftrc.sample
@@ -115,6 +115,19 @@
 #  respectively.
 #hrtf = auto
 
+## hrtf-mode:
+#  Specifies the rendering mode for HRTF processing. Setting the mode to full
+#  (default) applies a unique HRIR filter to each source given its relative
+#  location, providing the clearest directional response at the cost of the
+#  highest CPU usage. Setting the mode to ambi1, ambi2, or ambi3 will instead
+#  mix to a first-, second-, or third-order ambisonic buffer respectively, then
+#  decode that buffer with HRTF filters. Ambi1 has the lowest CPU usage,
+#  replacing the per-source HRIR filter for a simple 4-channel panning mix, but
+#  retains full 3D placement at the cost of a more diffuse response. Ambi2 and
+#  ambi3 increasingly improve the directional clarity, at the cost of more CPU
+#  usage (still less than "full", given some number of active sources).
+#hrtf-mode = full
+
 ## default-hrtf:
 #  Specifies the default HRTF to use. When multiple HRTFs are available, this
 #  determines the preferred one to use if none are specifically requested. Note