class_audioeffectstereoenhance.rst 3.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the AudioEffectStereoEnhance.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_AudioEffectStereoEnhance:
  5. AudioEffectStereoEnhance
  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_pan_pullout<class_AudioEffectStereoEnhance_get_pan_pullout>` **(** **)** const |
  15. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`get_surround<class_AudioEffectStereoEnhance_get_surround>` **(** **)** const |
  17. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`float<class_float>` | :ref:`get_time_pullout<class_AudioEffectStereoEnhance_get_time_pullout>` **(** **)** const |
  19. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  20. | void | :ref:`set_pan_pullout<class_AudioEffectStereoEnhance_set_pan_pullout>` **(** :ref:`float<class_float>` amount **)** |
  21. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`set_surround<class_AudioEffectStereoEnhance_set_surround>` **(** :ref:`float<class_float>` amount **)** |
  23. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`set_time_pullout<class_AudioEffectStereoEnhance_set_time_pullout>` **(** :ref:`float<class_float>` amount **)** |
  25. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  26. Member Variables
  27. ----------------
  28. - :ref:`float<class_float>` **pan_pullout**
  29. - :ref:`float<class_float>` **surround**
  30. - :ref:`float<class_float>` **time_pullout_ms**
  31. Member Function Description
  32. ---------------------------
  33. .. _class_AudioEffectStereoEnhance_get_pan_pullout:
  34. - :ref:`float<class_float>` **get_pan_pullout** **(** **)** const
  35. .. _class_AudioEffectStereoEnhance_get_surround:
  36. - :ref:`float<class_float>` **get_surround** **(** **)** const
  37. .. _class_AudioEffectStereoEnhance_get_time_pullout:
  38. - :ref:`float<class_float>` **get_time_pullout** **(** **)** const
  39. .. _class_AudioEffectStereoEnhance_set_pan_pullout:
  40. - void **set_pan_pullout** **(** :ref:`float<class_float>` amount **)**
  41. .. _class_AudioEffectStereoEnhance_set_surround:
  42. - void **set_surround** **(** :ref:`float<class_float>` amount **)**
  43. .. _class_AudioEffectStereoEnhance_set_time_pullout:
  44. - void **set_time_pullout** **(** :ref:`float<class_float>` amount **)**