summaryrefslogtreecommitdiffstats
path: root/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2019-04-15 14:49:41 +0200
committerRémi Verschelde <rverschelde@gmail.com>2019-04-15 14:49:41 +0200
commit09e94aa087485ccf5b4318c4a619db4f6b067cc5 (patch)
treeeec03ac9791d37c78a59332cbbcf5438f663f4d6 /doc/classes/AudioEffectSpectrumAnalyzerInstance.xml
parentdab8f8c953cd8ca18e792cc7aa0b717b38804e01 (diff)
downloadredot-engine-09e94aa087485ccf5b4318c4a619db4f6b067cc5.tar.gz
doc: Sync classref with current source
Diffstat (limited to 'doc/classes/AudioEffectSpectrumAnalyzerInstance.xml')
-rw-r--r--doc/classes/AudioEffectSpectrumAnalyzerInstance.xml31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml b/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml
new file mode 100644
index 0000000000..0c0061beb4
--- /dev/null
+++ b/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="AudioEffectSpectrumAnalyzerInstance" inherits="AudioEffectInstance" category="Core" version="3.2">
+ <brief_description>
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_magnitude_for_frequency_range" qualifiers="const">
+ <return type="Vector2">
+ </return>
+ <argument index="0" name="from_hz" type="float">
+ </argument>
+ <argument index="1" name="to_hz" type="float">
+ </argument>
+ <argument index="2" name="mode" type="int" enum="AudioEffectSpectrumAnalyzerInstance.MagnitudeMode" default="1">
+ </argument>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <constants>
+ <constant name="MAGNITUDE_AVERAGE" value="0" enum="MagnitudeMode">
+ </constant>
+ <constant name="MAGNITUDE_MAX" value="1" enum="MagnitudeMode">
+ </constant>
+ </constants>
+</class>