class_audioeffectstereoenhance.rst 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the AudioEffectStereoEnhance.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AudioEffectStereoEnhance:
  6. AudioEffectStereoEnhance
  7. ========================
  8. **Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Properties
  10. ----------
  11. +---------------------------+---------------------------------------------------------------------------------+---------+
  12. | :ref:`float<class_float>` | :ref:`pan_pullout<class_AudioEffectStereoEnhance_property_pan_pullout>` | ``1.0`` |
  13. +---------------------------+---------------------------------------------------------------------------------+---------+
  14. | :ref:`float<class_float>` | :ref:`surround<class_AudioEffectStereoEnhance_property_surround>` | ``0.0`` |
  15. +---------------------------+---------------------------------------------------------------------------------+---------+
  16. | :ref:`float<class_float>` | :ref:`time_pullout_ms<class_AudioEffectStereoEnhance_property_time_pullout_ms>` | ``0.0`` |
  17. +---------------------------+---------------------------------------------------------------------------------+---------+
  18. Property Descriptions
  19. ---------------------
  20. .. _class_AudioEffectStereoEnhance_property_pan_pullout:
  21. - :ref:`float<class_float>` **pan_pullout**
  22. +-----------+------------------------+
  23. | *Default* | ``1.0`` |
  24. +-----------+------------------------+
  25. | *Setter* | set_pan_pullout(value) |
  26. +-----------+------------------------+
  27. | *Getter* | get_pan_pullout() |
  28. +-----------+------------------------+
  29. ----
  30. .. _class_AudioEffectStereoEnhance_property_surround:
  31. - :ref:`float<class_float>` **surround**
  32. +-----------+---------------------+
  33. | *Default* | ``0.0`` |
  34. +-----------+---------------------+
  35. | *Setter* | set_surround(value) |
  36. +-----------+---------------------+
  37. | *Getter* | get_surround() |
  38. +-----------+---------------------+
  39. ----
  40. .. _class_AudioEffectStereoEnhance_property_time_pullout_ms:
  41. - :ref:`float<class_float>` **time_pullout_ms**
  42. +-----------+-------------------------+
  43. | *Default* | ``0.0`` |
  44. +-----------+-------------------------+
  45. | *Setter* | set_time_pullout(value) |
  46. +-----------+-------------------------+
  47. | *Getter* | get_time_pullout() |
  48. +-----------+-------------------------+
  49. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  50. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  51. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`