seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document AudioEffectSpectrumAnalyzerInstance, clarify relationship with AudioEffectSpectrumAnalyzer

Browse Source 
Fully document AudioEffectSpectrumAnalyzerInstance, including the weird
return value of its sole method, and add a link to it in
AudioEffectSpectrumAnalyzer to make it easier to figure out how to use.
This commit is contained in:
Blue Willow
2024-04-22 16:41:38 -07:00
parent 7ebc866418
commit b6c0d07dc8
2 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/classes/AudioEffectSpectrumAnalyzer.xml
View File

@ -5,6 +5,7 @@
</brief_description>
<description>
This audio effect does not affect sound output, but can be used for real-time audio visualizations.
This resource configures an [AudioEffectSpectrumAnalyzerInstance], which performs the actual analysis at runtime. An instance can be acquired with [method AudioServer.get_bus_effect_instance].
See also [AudioStreamGenerator] for procedurally generating sounds.
</description>
<tutorials>