class_audioeffectphaser.rst 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the AudioEffectPhaser.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_AudioEffectPhaser:
  5. AudioEffectPhaser
  6. =================
  7. **Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Member Functions
  12. ----------------
  13. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  14. | :ref:`float<class_float>` | :ref:`get_depth<class_AudioEffectPhaser_get_depth>` **(** **)** const |
  15. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`get_feedback<class_AudioEffectPhaser_get_feedback>` **(** **)** const |
  17. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  18. | :ref:`float<class_float>` | :ref:`get_range_max_hz<class_AudioEffectPhaser_get_range_max_hz>` **(** **)** const |
  19. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  20. | :ref:`float<class_float>` | :ref:`get_range_min_hz<class_AudioEffectPhaser_get_range_min_hz>` **(** **)** const |
  21. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  22. | :ref:`float<class_float>` | :ref:`get_rate_hz<class_AudioEffectPhaser_get_rate_hz>` **(** **)** const |
  23. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`set_depth<class_AudioEffectPhaser_set_depth>` **(** :ref:`float<class_float>` depth **)** |
  25. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  26. | void | :ref:`set_feedback<class_AudioEffectPhaser_set_feedback>` **(** :ref:`float<class_float>` fbk **)** |
  27. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  28. | void | :ref:`set_range_max_hz<class_AudioEffectPhaser_set_range_max_hz>` **(** :ref:`float<class_float>` hz **)** |
  29. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  30. | void | :ref:`set_range_min_hz<class_AudioEffectPhaser_set_range_min_hz>` **(** :ref:`float<class_float>` hz **)** |
  31. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  32. | void | :ref:`set_rate_hz<class_AudioEffectPhaser_set_rate_hz>` **(** :ref:`float<class_float>` hz **)** |
  33. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  34. Member Variables
  35. ----------------
  36. - :ref:`float<class_float>` **depth**
  37. - :ref:`float<class_float>` **feedback**
  38. - :ref:`float<class_float>` **range_max_hz**
  39. - :ref:`float<class_float>` **range_min_hz**
  40. - :ref:`float<class_float>` **rate_hz**
  41. Member Function Description
  42. ---------------------------
  43. .. _class_AudioEffectPhaser_get_depth:
  44. - :ref:`float<class_float>` **get_depth** **(** **)** const
  45. .. _class_AudioEffectPhaser_get_feedback:
  46. - :ref:`float<class_float>` **get_feedback** **(** **)** const
  47. .. _class_AudioEffectPhaser_get_range_max_hz:
  48. - :ref:`float<class_float>` **get_range_max_hz** **(** **)** const
  49. .. _class_AudioEffectPhaser_get_range_min_hz:
  50. - :ref:`float<class_float>` **get_range_min_hz** **(** **)** const
  51. .. _class_AudioEffectPhaser_get_rate_hz:
  52. - :ref:`float<class_float>` **get_rate_hz** **(** **)** const
  53. .. _class_AudioEffectPhaser_set_depth:
  54. - void **set_depth** **(** :ref:`float<class_float>` depth **)**
  55. .. _class_AudioEffectPhaser_set_feedback:
  56. - void **set_feedback** **(** :ref:`float<class_float>` fbk **)**
  57. .. _class_AudioEffectPhaser_set_range_max_hz:
  58. - void **set_range_max_hz** **(** :ref:`float<class_float>` hz **)**
  59. .. _class_AudioEffectPhaser_set_range_min_hz:
  60. - void **set_range_min_hz** **(** :ref:`float<class_float>` hz **)**
  61. .. _class_AudioEffectPhaser_set_rate_hz:
  62. - void **set_rate_hz** **(** :ref:`float<class_float>` hz **)**