class_audioeffectinstance.rst 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the AudioEffectInstance.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AudioEffectInstance:
  6. AudioEffectInstance
  7. ===================
  8. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. **Inherited By:** :ref:`AudioEffectSpectrumAnalyzerInstance<class_AudioEffectSpectrumAnalyzerInstance>`
  10. Methods
  11. -------
  12. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  13. | void | :ref:`_process<class_AudioEffectInstance_method__process>` **(** const void* src_buffer, AudioFrame* dst_buffer, :ref:`int<class_int>` frame_count **)** |virtual| |
  14. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`bool<class_bool>` | :ref:`_process_silence<class_AudioEffectInstance_method__process_silence>` **(** **)** |virtual| |const| |
  16. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. Method Descriptions
  18. -------------------
  19. .. _class_AudioEffectInstance_method__process:
  20. - void **_process** **(** const void* src_buffer, AudioFrame* dst_buffer, :ref:`int<class_int>` frame_count **)** |virtual|
  21. ----
  22. .. _class_AudioEffectInstance_method__process_silence:
  23. - :ref:`bool<class_bool>` **_process_silence** **(** **)** |virtual| |const|
  24. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  25. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  26. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  27. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  28. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  29. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`