summaryrefslogtreecommitdiffstats
path: root/OpenAL32/Include
diff options
context:
space:
mode:
authorChris Robinson <[email protected]>2014-05-17 02:09:43 -0700
committerChris Robinson <[email protected]>2014-05-17 02:09:43 -0700
commit1efddac3dbdf6bb2192172c6d09be374205d1221 (patch)
tree546f9dcf3b8b329d6b3eafbfeedfb88df99e3c3d /OpenAL32/Include
parentc5b25ba2a76e50090c82dc0e246bce422ce9e4fc (diff)
Document the different filter types, and combine some split lines
Diffstat (limited to 'OpenAL32/Include')
-rw-r--r--OpenAL32/Include/alFilter.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/OpenAL32/Include/alFilter.h b/OpenAL32/Include/alFilter.h
index 4a66ef9b..86547182 100644
--- a/OpenAL32/Include/alFilter.h
+++ b/OpenAL32/Include/alFilter.h
@@ -15,12 +15,18 @@ extern "C" {
* http://www.musicdsp.org/files/Audio-EQ-Cookbook.txt */
typedef enum ALfilterType {
+ /** EFX-style low-pass filter, specifying a gain and reference frequency. */
ALfilterType_HighShelf,
+ /** EFX-style high-pass filter, specifying a gain and reference frequency. */
ALfilterType_LowShelf,
+ /** Peaking filter, specifying a gain, reference frequency, and bandwidth. */
ALfilterType_Peaking,
+ /** Low-pass cut-off filter, specifying a cut-off frequency and bandwidth. */
ALfilterType_LowPass,
+ /** High-pass cut-off filter, specifying a cut-off frequency and bandwidth. */
ALfilterType_HighPass,
+ /** Band-pass filter, specifying a center frequency and bandwidth. */
ALfilterType_BandPass,
} ALfilterType;