mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
48 lines
1.5 KiB
ReStructuredText
48 lines
1.5 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the AudioEffectPitchShift.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_AudioEffectPitchShift:
|
|
|
|
AudioEffectPitchShift
|
|
=====================
|
|
|
|
**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Adds a Pitch shift audio effect to an Audio bus.
|
|
|
|
Raises or lowers the pitch of original sound.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------+----------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioEffectPitchShift_property_pitch_scale>` |
|
|
+---------------------------+----------------------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_AudioEffectPitchShift_property_pitch_scale:
|
|
|
|
- :ref:`float<class_float>` **pitch_scale**
|
|
|
|
+----------+------------------------+
|
|
| *Setter* | set_pitch_scale(value) |
|
|
+----------+------------------------+
|
|
| *Getter* | get_pitch_scale() |
|
|
+----------+------------------------+
|
|
|
|
Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves).
|
|
|