class_audioeffectinstance.rst 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  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. .. container:: contribute
  12. There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  13. .. rst-class:: classref-reftable-group
  14. Methods
  15. -------
  16. .. table::
  17. :widths: auto
  18. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`_process<class_AudioEffectInstance_private_method__process>` **(** const void* src_buffer, AudioFrame* dst_buffer, :ref:`int<class_int>` frame_count **)** |virtual| |
  20. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`bool<class_bool>` | :ref:`_process_silence<class_AudioEffectInstance_private_method__process_silence>` **(** **)** |virtual| |const| |
  22. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. .. rst-class:: classref-section-separator
  24. ----
  25. .. rst-class:: classref-descriptions-group
  26. Method Descriptions
  27. -------------------
  28. .. _class_AudioEffectInstance_private_method__process:
  29. .. rst-class:: classref-method
  30. void **_process** **(** const void* src_buffer, AudioFrame* dst_buffer, :ref:`int<class_int>` frame_count **)** |virtual|
  31. .. container:: contribute
  32. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  33. .. rst-class:: classref-item-separator
  34. ----
  35. .. _class_AudioEffectInstance_private_method__process_silence:
  36. .. rst-class:: classref-method
  37. :ref:`bool<class_bool>` **_process_silence** **(** **)** |virtual| |const|
  38. .. container:: contribute
  39. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  40. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  41. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  42. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  43. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  44. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  45. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  46. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`