Files
godot-docs/classes/class_audioeffectpanner.rst
2017-10-11 23:56:28 +02:00

50 lines
1.7 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AudioEffectPanner.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_AudioEffectPanner:
AudioEffectPanner
=================
**Inherits:** :ref:`AudioEffect<class_audioeffect>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Adds a Panner audio effect to an Audio bus. Pans sound left or right.
Member Functions
----------------
+----------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pan<class_AudioEffectPanner_get_pan>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------+
| void | :ref:`set_pan<class_AudioEffectPanner_set_pan>` **(** :ref:`float<class_float>` cpanume **)** |
+----------------------------+-------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **pan** - Pan position. Value can range from -1 (fully left) to 1 (fully right).
Description
-----------
Determines how much of an audio signal is sent to the left and right buses.
Member Function Description
---------------------------
.. _class_AudioEffectPanner_get_pan:
- :ref:`float<class_float>` **get_pan** **(** **)** const
.. _class_AudioEffectPanner_set_pan:
- void **set_pan** **(** :ref:`float<class_float>` cpanume **)**