class_audioeffectbandpassfilter.rst 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectBandPassFilter.xml.
  6. .. _class_AudioEffectBandPassFilter:
  7. AudioEffectBandPassFilter
  8. =========================
  9. **Inherits:** :ref:`AudioEffectFilter<class_AudioEffectFilter>` **<** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Adds a band pass filter to the audio bus.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Attenuates the frequencies inside of a range around the :ref:`AudioEffectFilter.cutoff_hz<class_AudioEffectFilter_property_cutoff_hz>` and cuts frequencies outside of this band.
  15. .. rst-class:: classref-introduction-group
  16. Tutorials
  17. ---------
  18. - :doc:`Audio buses <../tutorials/audio/audio_buses>`
  19. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  20. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  21. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  22. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  23. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  24. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  25. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  26. .. |void| replace:: :abbr:`void (No return value.)`