classref: Sync with latest 4.0-dev

classes/class_audioeffectpitchshift.rst

@@ -9,7 +9,7 @@
 AudioEffectPitchShift
 =====================
 
-**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
+**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
 
 Adds a pitch-shifting audio effect to an Audio bus.
 
@@ -23,18 +23,18 @@ Allows modulation of pitch independently of tempo. All frequencies can be increa
 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`` |
-+------------------------------------------------------+------------------------------------------------------------------------+---------+
++----------------------------------------------------+------------------------------------------------------------------------+---------+
+| :ref:`FFTSize<enum_AudioEffectPitchShift_FFTSize>` | :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:
+.. _enum_AudioEffectPitchShift_FFTSize:
 
 .. _class_AudioEffectPitchShift_constant_FFT_SIZE_256:
 
@@ -48,26 +48,26 @@ Enumerations
 
 .. _class_AudioEffectPitchShift_constant_FFT_SIZE_MAX:
 
-enum **FFT_Size**:
+enum **FFTSize**:
 
-- **FFT_SIZE_256** = **0**
+- **FFT_SIZE_256** = **0** --- Use a buffer of 256 samples for the Fast Fourier transform. Lowest latency, but least stable over time.
 
-- **FFT_SIZE_512** = **1**
+- **FFT_SIZE_512** = **1** --- Use a buffer of 512 samples for the Fast Fourier transform. Low latency, but less stable over time.
 
-- **FFT_SIZE_1024** = **2**
+- **FFT_SIZE_1024** = **2** --- Use a buffer of 1024 samples for the Fast Fourier transform. This is a compromise between latency and stability over time.
 
-- **FFT_SIZE_2048** = **3**
+- **FFT_SIZE_2048** = **3** --- Use a buffer of 2048 samples for the Fast Fourier transform. High latency, but stable over time.
 
-- **FFT_SIZE_4096** = **4**
+- **FFT_SIZE_4096** = **4** --- Use a buffer of 4096 samples for the Fast Fourier transform. Highest latency, but most stable over time.
 
-- **FFT_SIZE_MAX** = **5** --- Represents the size of the :ref:`FFT_Size<enum_AudioEffectPitchShift_FFT_Size>` enum.
+- **FFT_SIZE_MAX** = **5** --- Represents the size of the :ref:`FFTSize<enum_AudioEffectPitchShift_FFTSize>` enum.
 
 Property Descriptions
 ---------------------
 
 .. _class_AudioEffectPitchShift_property_fft_size:
 
-- :ref:`FFT_Size<enum_AudioEffectPitchShift_FFT_Size>` **fft_size**
+- :ref:`FFTSize<enum_AudioEffectPitchShift_FFTSize>` **fft_size**
 
 +-----------+---------------------+
 | *Default* | ``3``               |
@@ -77,6 +77,8 @@ Property Descriptions
 | *Getter*  | get_fft_size()      |
 +-----------+---------------------+
 
+The size of the `Fast Fourier transform <https://en.wikipedia.org/wiki/Fast_Fourier_transform>`__ buffer. Higher values smooth out the effect over time, but have greater latency. The effects of this higher latency are especially noticeable on sounds that have sudden amplitude changes.
+
 ----
 
 .. _class_AudioEffectPitchShift_property_oversampling:
@@ -91,6 +93,8 @@ Property Descriptions
 | *Getter*  | get_oversampling()      |
 +-----------+-------------------------+
 
+The oversampling factor to use. Higher values result in better quality, but are more demanding on the CPU and may cause audio cracking if the CPU can't keep up.
+
 ----
 
 .. _class_AudioEffectPitchShift_property_pitch_scale:
@@ -105,5 +109,11 @@ Property Descriptions
 | *Getter*  | get_pitch_scale()      |
 +-----------+------------------------+
 
-Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves).
+The pitch scale to use. ``1.0`` is the default pitch and plays sounds unaltered. :ref:`pitch_scale<class_AudioEffectPitchShift_property_pitch_scale>` can range from ``0.0`` (infinitely low pitch, inaudible) to ``16`` (16 times higher than the initial pitch).
 
+.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
+.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
+.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
+.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
+.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
+.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`