f5836b40d4
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
27 lines
907 B
XML
27 lines
907 B
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AudioEffectSpectrumAnalyzerInstance" inherits="AudioEffectInstance" version="3.4">
|
|
<brief_description>
|
|
</brief_description>
|
|
<description>
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_magnitude_for_frequency_range" qualifiers="const">
|
|
<return type="Vector2" />
|
|
<argument index="0" name="from_hz" type="float" />
|
|
<argument index="1" name="to_hz" type="float" />
|
|
<argument index="2" name="mode" type="int" enum="AudioEffectSpectrumAnalyzerInstance.MagnitudeMode" default="1" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
<constant name="MAGNITUDE_AVERAGE" value="0" enum="MagnitudeMode">
|
|
Use the average value as magnitude.
|
|
</constant>
|
|
<constant name="MAGNITUDE_MAX" value="1" enum="MagnitudeMode">
|
|
Use the maximum value as magnitude.
|
|
</constant>
|
|
</constants>
|
|
</class>
|