class_audioeffectdelay.rst 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the AudioEffectDelay.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_AudioEffectDelay:
  5. AudioEffectDelay
  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_dry<class_AudioEffectDelay_get_dry>` **(** **)** |
  15. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`get_feedback_delay_ms<class_AudioEffectDelay_get_feedback_delay_ms>` **(** **)** const |
  17. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`float<class_float>` | :ref:`get_feedback_level_db<class_AudioEffectDelay_get_feedback_level_db>` **(** **)** const |
  19. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`float<class_float>` | :ref:`get_feedback_lowpass<class_AudioEffectDelay_get_feedback_lowpass>` **(** **)** const |
  21. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`float<class_float>` | :ref:`get_tap1_delay_ms<class_AudioEffectDelay_get_tap1_delay_ms>` **(** **)** const |
  23. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`float<class_float>` | :ref:`get_tap1_level_db<class_AudioEffectDelay_get_tap1_level_db>` **(** **)** const |
  25. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`float<class_float>` | :ref:`get_tap1_pan<class_AudioEffectDelay_get_tap1_pan>` **(** **)** const |
  27. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`float<class_float>` | :ref:`get_tap2_delay_ms<class_AudioEffectDelay_get_tap2_delay_ms>` **(** **)** const |
  29. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`float<class_float>` | :ref:`get_tap2_level_db<class_AudioEffectDelay_get_tap2_level_db>` **(** **)** const |
  31. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`float<class_float>` | :ref:`get_tap2_pan<class_AudioEffectDelay_get_tap2_pan>` **(** **)** const |
  33. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  34. | :ref:`bool<class_bool>` | :ref:`is_feedback_active<class_AudioEffectDelay_is_feedback_active>` **(** **)** const |
  35. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`bool<class_bool>` | :ref:`is_tap1_active<class_AudioEffectDelay_is_tap1_active>` **(** **)** const |
  37. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  38. | :ref:`bool<class_bool>` | :ref:`is_tap2_active<class_AudioEffectDelay_is_tap2_active>` **(** **)** const |
  39. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  40. | void | :ref:`set_dry<class_AudioEffectDelay_set_dry>` **(** :ref:`float<class_float>` amount **)** |
  41. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  42. | void | :ref:`set_feedback_active<class_AudioEffectDelay_set_feedback_active>` **(** :ref:`bool<class_bool>` amount **)** |
  43. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  44. | void | :ref:`set_feedback_delay_ms<class_AudioEffectDelay_set_feedback_delay_ms>` **(** :ref:`float<class_float>` amount **)** |
  45. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  46. | void | :ref:`set_feedback_level_db<class_AudioEffectDelay_set_feedback_level_db>` **(** :ref:`float<class_float>` amount **)** |
  47. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  48. | void | :ref:`set_feedback_lowpass<class_AudioEffectDelay_set_feedback_lowpass>` **(** :ref:`float<class_float>` amount **)** |
  49. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  50. | void | :ref:`set_tap1_active<class_AudioEffectDelay_set_tap1_active>` **(** :ref:`bool<class_bool>` amount **)** |
  51. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  52. | void | :ref:`set_tap1_delay_ms<class_AudioEffectDelay_set_tap1_delay_ms>` **(** :ref:`float<class_float>` amount **)** |
  53. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  54. | void | :ref:`set_tap1_level_db<class_AudioEffectDelay_set_tap1_level_db>` **(** :ref:`float<class_float>` amount **)** |
  55. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  56. | void | :ref:`set_tap1_pan<class_AudioEffectDelay_set_tap1_pan>` **(** :ref:`float<class_float>` amount **)** |
  57. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  58. | void | :ref:`set_tap2_active<class_AudioEffectDelay_set_tap2_active>` **(** :ref:`bool<class_bool>` amount **)** |
  59. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  60. | void | :ref:`set_tap2_delay_ms<class_AudioEffectDelay_set_tap2_delay_ms>` **(** :ref:`float<class_float>` amount **)** |
  61. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  62. | void | :ref:`set_tap2_level_db<class_AudioEffectDelay_set_tap2_level_db>` **(** :ref:`float<class_float>` amount **)** |
  63. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  64. | void | :ref:`set_tap2_pan<class_AudioEffectDelay_set_tap2_pan>` **(** :ref:`float<class_float>` amount **)** |
  65. +----------------------------+---------------------------------------------------------------------------------------------------------------------------+
  66. Member Variables
  67. ----------------
  68. - :ref:`float<class_float>` **dry**
  69. - :ref:`bool<class_bool>` **feedback/active**
  70. - :ref:`float<class_float>` **feedback/delay_ms**
  71. - :ref:`float<class_float>` **feedback/level_db**
  72. - :ref:`float<class_float>` **feedback/lowpass**
  73. - :ref:`bool<class_bool>` **tap1/active**
  74. - :ref:`float<class_float>` **tap1/delay_ms**
  75. - :ref:`float<class_float>` **tap1/level_db**
  76. - :ref:`float<class_float>` **tap1/pan**
  77. - :ref:`bool<class_bool>` **tap2/active**
  78. - :ref:`float<class_float>` **tap2/delay_ms**
  79. - :ref:`float<class_float>` **tap2/level_db**
  80. - :ref:`float<class_float>` **tap2/pan**
  81. Member Function Description
  82. ---------------------------
  83. .. _class_AudioEffectDelay_get_dry:
  84. - :ref:`float<class_float>` **get_dry** **(** **)**
  85. .. _class_AudioEffectDelay_get_feedback_delay_ms:
  86. - :ref:`float<class_float>` **get_feedback_delay_ms** **(** **)** const
  87. .. _class_AudioEffectDelay_get_feedback_level_db:
  88. - :ref:`float<class_float>` **get_feedback_level_db** **(** **)** const
  89. .. _class_AudioEffectDelay_get_feedback_lowpass:
  90. - :ref:`float<class_float>` **get_feedback_lowpass** **(** **)** const
  91. .. _class_AudioEffectDelay_get_tap1_delay_ms:
  92. - :ref:`float<class_float>` **get_tap1_delay_ms** **(** **)** const
  93. .. _class_AudioEffectDelay_get_tap1_level_db:
  94. - :ref:`float<class_float>` **get_tap1_level_db** **(** **)** const
  95. .. _class_AudioEffectDelay_get_tap1_pan:
  96. - :ref:`float<class_float>` **get_tap1_pan** **(** **)** const
  97. .. _class_AudioEffectDelay_get_tap2_delay_ms:
  98. - :ref:`float<class_float>` **get_tap2_delay_ms** **(** **)** const
  99. .. _class_AudioEffectDelay_get_tap2_level_db:
  100. - :ref:`float<class_float>` **get_tap2_level_db** **(** **)** const
  101. .. _class_AudioEffectDelay_get_tap2_pan:
  102. - :ref:`float<class_float>` **get_tap2_pan** **(** **)** const
  103. .. _class_AudioEffectDelay_is_feedback_active:
  104. - :ref:`bool<class_bool>` **is_feedback_active** **(** **)** const
  105. .. _class_AudioEffectDelay_is_tap1_active:
  106. - :ref:`bool<class_bool>` **is_tap1_active** **(** **)** const
  107. .. _class_AudioEffectDelay_is_tap2_active:
  108. - :ref:`bool<class_bool>` **is_tap2_active** **(** **)** const
  109. .. _class_AudioEffectDelay_set_dry:
  110. - void **set_dry** **(** :ref:`float<class_float>` amount **)**
  111. .. _class_AudioEffectDelay_set_feedback_active:
  112. - void **set_feedback_active** **(** :ref:`bool<class_bool>` amount **)**
  113. .. _class_AudioEffectDelay_set_feedback_delay_ms:
  114. - void **set_feedback_delay_ms** **(** :ref:`float<class_float>` amount **)**
  115. .. _class_AudioEffectDelay_set_feedback_level_db:
  116. - void **set_feedback_level_db** **(** :ref:`float<class_float>` amount **)**
  117. .. _class_AudioEffectDelay_set_feedback_lowpass:
  118. - void **set_feedback_lowpass** **(** :ref:`float<class_float>` amount **)**
  119. .. _class_AudioEffectDelay_set_tap1_active:
  120. - void **set_tap1_active** **(** :ref:`bool<class_bool>` amount **)**
  121. .. _class_AudioEffectDelay_set_tap1_delay_ms:
  122. - void **set_tap1_delay_ms** **(** :ref:`float<class_float>` amount **)**
  123. .. _class_AudioEffectDelay_set_tap1_level_db:
  124. - void **set_tap1_level_db** **(** :ref:`float<class_float>` amount **)**
  125. .. _class_AudioEffectDelay_set_tap1_pan:
  126. - void **set_tap1_pan** **(** :ref:`float<class_float>` amount **)**
  127. .. _class_AudioEffectDelay_set_tap2_active:
  128. - void **set_tap2_active** **(** :ref:`bool<class_bool>` amount **)**
  129. .. _class_AudioEffectDelay_set_tap2_delay_ms:
  130. - void **set_tap2_delay_ms** **(** :ref:`float<class_float>` amount **)**
  131. .. _class_AudioEffectDelay_set_tap2_level_db:
  132. - void **set_tap2_level_db** **(** :ref:`float<class_float>` amount **)**
  133. .. _class_AudioEffectDelay_set_tap2_pan:
  134. - void **set_tap2_pan** **(** :ref:`float<class_float>` amount **)**