class_audioeffectpanner.rst 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the AudioEffectPanner.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_AudioEffectPanner:
  5. AudioEffectPanner
  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. Adds a Panner audio effect to an Audio bus. Pans sound left or right.
  12. Member Functions
  13. ----------------
  14. +----------------------------+-------------------------------------------------------------------------------------------------+
  15. | :ref:`float<class_float>` | :ref:`get_pan<class_AudioEffectPanner_get_pan>` **(** **)** const |
  16. +----------------------------+-------------------------------------------------------------------------------------------------+
  17. | void | :ref:`set_pan<class_AudioEffectPanner_set_pan>` **(** :ref:`float<class_float>` cpanume **)** |
  18. +----------------------------+-------------------------------------------------------------------------------------------------+
  19. Member Variables
  20. ----------------
  21. - :ref:`float<class_float>` **pan** - Pan position. Value can range from -1 (fully left) to 1 (fully right).
  22. Description
  23. -----------
  24. Determines how much of an audio signal is sent to the left and right buses.
  25. Member Function Description
  26. ---------------------------
  27. .. _class_AudioEffectPanner_get_pan:
  28. - :ref:`float<class_float>` **get_pan** **(** **)** const
  29. .. _class_AudioEffectPanner_set_pan:
  30. - void **set_pan** **(** :ref:`float<class_float>` cpanume **)**