class_audioeffectpitchshift.rst 1.5 KB

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