class_audioeffectreverb.rst 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the AudioEffectReverb.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_AudioEffectReverb:
  5. AudioEffectReverb
  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_damping<class_AudioEffectReverb_get_damping>` **(** **)** const |
  15. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`get_dry<class_AudioEffectReverb_get_dry>` **(** **)** const |
  17. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`float<class_float>` | :ref:`get_hpf<class_AudioEffectReverb_get_hpf>` **(** **)** const |
  19. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`float<class_float>` | :ref:`get_predelay_feedback<class_AudioEffectReverb_get_predelay_feedback>` **(** **)** const |
  21. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`float<class_float>` | :ref:`get_predelay_msec<class_AudioEffectReverb_get_predelay_msec>` **(** **)** const |
  23. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`float<class_float>` | :ref:`get_room_size<class_AudioEffectReverb_get_room_size>` **(** **)** const |
  25. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`float<class_float>` | :ref:`get_spread<class_AudioEffectReverb_get_spread>` **(** **)** const |
  27. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`float<class_float>` | :ref:`get_wet<class_AudioEffectReverb_get_wet>` **(** **)** const |
  29. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  30. | void | :ref:`set_damping<class_AudioEffectReverb_set_damping>` **(** :ref:`float<class_float>` amount **)** |
  31. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  32. | void | :ref:`set_dry<class_AudioEffectReverb_set_dry>` **(** :ref:`float<class_float>` amount **)** |
  33. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  34. | void | :ref:`set_hpf<class_AudioEffectReverb_set_hpf>` **(** :ref:`float<class_float>` amount **)** |
  35. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  36. | void | :ref:`set_predelay_feedback<class_AudioEffectReverb_set_predelay_feedback>` **(** :ref:`float<class_float>` feedback **)** |
  37. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  38. | void | :ref:`set_predelay_msec<class_AudioEffectReverb_set_predelay_msec>` **(** :ref:`float<class_float>` msec **)** |
  39. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  40. | void | :ref:`set_room_size<class_AudioEffectReverb_set_room_size>` **(** :ref:`float<class_float>` size **)** |
  41. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  42. | void | :ref:`set_spread<class_AudioEffectReverb_set_spread>` **(** :ref:`float<class_float>` amount **)** |
  43. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  44. | void | :ref:`set_wet<class_AudioEffectReverb_set_wet>` **(** :ref:`float<class_float>` amount **)** |
  45. +----------------------------+------------------------------------------------------------------------------------------------------------------------------+
  46. Member Variables
  47. ----------------
  48. - :ref:`float<class_float>` **damping**
  49. - :ref:`float<class_float>` **dry**
  50. - :ref:`float<class_float>` **hipass**
  51. - :ref:`float<class_float>` **predelay_feedback**
  52. - :ref:`float<class_float>` **predelay_msec**
  53. - :ref:`float<class_float>` **room_size**
  54. - :ref:`float<class_float>` **spread**
  55. - :ref:`float<class_float>` **wet**
  56. Member Function Description
  57. ---------------------------
  58. .. _class_AudioEffectReverb_get_damping:
  59. - :ref:`float<class_float>` **get_damping** **(** **)** const
  60. .. _class_AudioEffectReverb_get_dry:
  61. - :ref:`float<class_float>` **get_dry** **(** **)** const
  62. .. _class_AudioEffectReverb_get_hpf:
  63. - :ref:`float<class_float>` **get_hpf** **(** **)** const
  64. .. _class_AudioEffectReverb_get_predelay_feedback:
  65. - :ref:`float<class_float>` **get_predelay_feedback** **(** **)** const
  66. .. _class_AudioEffectReverb_get_predelay_msec:
  67. - :ref:`float<class_float>` **get_predelay_msec** **(** **)** const
  68. .. _class_AudioEffectReverb_get_room_size:
  69. - :ref:`float<class_float>` **get_room_size** **(** **)** const
  70. .. _class_AudioEffectReverb_get_spread:
  71. - :ref:`float<class_float>` **get_spread** **(** **)** const
  72. .. _class_AudioEffectReverb_get_wet:
  73. - :ref:`float<class_float>` **get_wet** **(** **)** const
  74. .. _class_AudioEffectReverb_set_damping:
  75. - void **set_damping** **(** :ref:`float<class_float>` amount **)**
  76. .. _class_AudioEffectReverb_set_dry:
  77. - void **set_dry** **(** :ref:`float<class_float>` amount **)**
  78. .. _class_AudioEffectReverb_set_hpf:
  79. - void **set_hpf** **(** :ref:`float<class_float>` amount **)**
  80. .. _class_AudioEffectReverb_set_predelay_feedback:
  81. - void **set_predelay_feedback** **(** :ref:`float<class_float>` feedback **)**
  82. .. _class_AudioEffectReverb_set_predelay_msec:
  83. - void **set_predelay_msec** **(** :ref:`float<class_float>` msec **)**
  84. .. _class_AudioEffectReverb_set_room_size:
  85. - void **set_room_size** **(** :ref:`float<class_float>` size **)**
  86. .. _class_AudioEffectReverb_set_spread:
  87. - void **set_spread** **(** :ref:`float<class_float>` amount **)**
  88. .. _class_AudioEffectReverb_set_wet:
  89. - void **set_wet** **(** :ref:`float<class_float>` amount **)**