| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108 |
- .. 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-shifting audio effect to an Audio bus.
- Raises or lowers the pitch of original sound.
- Properties
- ----------
- +------------------------------------------------------+------------------------------------------------------------------------+-----+
- | :ref:`FFT_Size<enum_AudioEffectPitchShift_FFT_Size>` | :ref:`fft_size<class_AudioEffectPitchShift_property_fft_size>` | 3 |
- +------------------------------------------------------+------------------------------------------------------------------------+-----+
- | :ref:`int<class_int>` | :ref:`oversampling<class_AudioEffectPitchShift_property_oversampling>` | 4 |
- +------------------------------------------------------+------------------------------------------------------------------------+-----+
- | :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioEffectPitchShift_property_pitch_scale>` | 1.0 |
- +------------------------------------------------------+------------------------------------------------------------------------+-----+
- Enumerations
- ------------
- .. _enum_AudioEffectPitchShift_FFT_Size:
- .. _class_AudioEffectPitchShift_constant_FFT_SIZE_256:
- .. _class_AudioEffectPitchShift_constant_FFT_SIZE_512:
- .. _class_AudioEffectPitchShift_constant_FFT_SIZE_1024:
- .. _class_AudioEffectPitchShift_constant_FFT_SIZE_2048:
- .. _class_AudioEffectPitchShift_constant_FFT_SIZE_4096:
- .. _class_AudioEffectPitchShift_constant_FFT_SIZE_MAX:
- enum **FFT_Size**:
- - **FFT_SIZE_256** = **0**
- - **FFT_SIZE_512** = **1**
- - **FFT_SIZE_1024** = **2**
- - **FFT_SIZE_2048** = **3**
- - **FFT_SIZE_4096** = **4**
- - **FFT_SIZE_MAX** = **5** --- Represents the size of the :ref:`FFT_Size<enum_AudioEffectPitchShift_FFT_Size>` enum.
- Description
- -----------
- Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients.
- Property Descriptions
- ---------------------
- .. _class_AudioEffectPitchShift_property_fft_size:
- - :ref:`FFT_Size<enum_AudioEffectPitchShift_FFT_Size>` **fft_size**
- +-----------+---------------------+
- | *Default* | 3 |
- +-----------+---------------------+
- | *Setter* | set_fft_size(value) |
- +-----------+---------------------+
- | *Getter* | get_fft_size() |
- +-----------+---------------------+
- .. _class_AudioEffectPitchShift_property_oversampling:
- - :ref:`int<class_int>` **oversampling**
- +-----------+-------------------------+
- | *Default* | 4 |
- +-----------+-------------------------+
- | *Setter* | set_oversampling(value) |
- +-----------+-------------------------+
- | *Getter* | get_oversampling() |
- +-----------+-------------------------+
- .. _class_AudioEffectPitchShift_property_pitch_scale:
- - :ref:`float<class_float>` **pitch_scale**
- +-----------+------------------------+
- | *Default* | 1.0 |
- +-----------+------------------------+
- | *Setter* | set_pitch_scale(value) |
- +-----------+------------------------+
- | *Getter* | get_pitch_scale() |
- +-----------+------------------------+
- Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves).
|
