class_audioeffectpitchshift.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the AudioEffectPitchShift.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AudioEffectPitchShift:
  6. AudioEffectPitchShift
  7. =====================
  8. **Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Adds a Pitch shift audio effect to an Audio bus.
  13. Raises or lowers the pitch of original sound.
  14. Properties
  15. ----------
  16. +---------------------------+----------------------------------------------------------------------+
  17. | :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioEffectPitchShift_property_pitch_scale>` |
  18. +---------------------------+----------------------------------------------------------------------+
  19. Description
  20. -----------
  21. Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients.
  22. Property Descriptions
  23. ---------------------
  24. .. _class_AudioEffectPitchShift_property_pitch_scale:
  25. - :ref:`float<class_float>` **pitch_scale**
  26. +----------+------------------------+
  27. | *Setter* | set_pitch_scale(value) |
  28. +----------+------------------------+
  29. | *Getter* | get_pitch_scale() |
  30. +----------+------------------------+
  31. Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves).