class_audioeffectinstance.rst 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  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/AudioEffectInstance.xml.
  6. .. _class_AudioEffectInstance:
  7. AudioEffectInstance
  8. ===================
  9. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`AudioEffectSpectrumAnalyzerInstance<class_AudioEffectSpectrumAnalyzerInstance>`
  11. Methods
  12. -------
  13. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  14. | void | :ref:`_process<class_AudioEffectInstance_method__process>` **(** const void* src_buffer, AudioFrame* dst_buffer, :ref:`int<class_int>` frame_count **)** |virtual| |
  15. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`bool<class_bool>` | :ref:`_process_silence<class_AudioEffectInstance_method__process_silence>` **(** **)** |virtual| |const| |
  17. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. Method Descriptions
  19. -------------------
  20. .. _class_AudioEffectInstance_method__process:
  21. - void **_process** **(** const void* src_buffer, AudioFrame* dst_buffer, :ref:`int<class_int>` frame_count **)** |virtual|
  22. ----
  23. .. _class_AudioEffectInstance_method__process_silence:
  24. - :ref:`bool<class_bool>` **_process_silence** **(** **)** |virtual| |const|
  25. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  26. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  27. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  28. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  29. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  30. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`