[−][src]Struct gdnative_bindings::audio_effect_chorus::AudioEffectChorus
core class AudioEffectChorus
inherits AudioEffect
(reference counted).
Official documentation
See the documentation of this class in the Godot engine's official documentation.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
AudioEffectChorus inherits methods from:
Safety
All types in the Godot API have "interior mutability" in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
impl AudioEffectChorus
[src]
pub fn new() -> Ref<Self, Unique>
[src]
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
pub fn dry(&self) -> f64
[src]
The effect's raw signal.
pub fn voice_count(&self) -> i64
[src]
The amount of voices in the effect.
pub fn voice_cutoff_hz(&self, voice_idx: i64) -> f64
[src]
The voice's cutoff frequency.
pub fn voice_delay_ms(&self, voice_idx: i64) -> f64
[src]
The voice's signal delay.
pub fn voice_depth_ms(&self, voice_idx: i64) -> f64
[src]
The voice filter's depth.
pub fn voice_level_db(&self, voice_idx: i64) -> f64
[src]
The voice's volume.
pub fn voice_pan(&self, voice_idx: i64) -> f64
[src]
The voice's pan level.
pub fn voice_rate_hz(&self, voice_idx: i64) -> f64
[src]
The voice's filter rate.
pub fn wet(&self) -> f64
[src]
The effect's processed signal.
pub fn set_dry(&self, amount: f64)
[src]
The effect's raw signal.
pub fn set_voice_count(&self, voices: i64)
[src]
The amount of voices in the effect.
pub fn set_voice_cutoff_hz(&self, voice_idx: i64, cutoff_hz: f64)
[src]
The voice's cutoff frequency.
pub fn set_voice_delay_ms(&self, voice_idx: i64, delay_ms: f64)
[src]
The voice's signal delay.
pub fn set_voice_depth_ms(&self, voice_idx: i64, depth_ms: f64)
[src]
The voice filter's depth.
pub fn set_voice_level_db(&self, voice_idx: i64, level_db: f64)
[src]
The voice's volume.
pub fn set_voice_pan(&self, voice_idx: i64, pan: f64)
[src]
The voice's pan level.
pub fn set_voice_rate_hz(&self, voice_idx: i64, rate_hz: f64)
[src]
The voice's filter rate.
pub fn set_wet(&self, amount: f64)
[src]
The effect's processed signal.
Trait Implementations
impl Debug for AudioEffectChorus
[src]
impl Deref for AudioEffectChorus
[src]
type Target = AudioEffect
The resulting type after dereferencing.
fn deref(&self) -> &AudioEffect
[src]
impl DerefMut for AudioEffectChorus
[src]
fn deref_mut(&mut self) -> &mut AudioEffect
[src]
impl GodotObject for AudioEffectChorus
[src]
type RefKind = RefCounted
The memory management kind of this type. This modifies the behavior of the
Ref
smart pointer. See its type-level documentation for more
information. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for AudioEffectChorus
[src]
impl Sealed for AudioEffectChorus
[src]
impl SubClass<AudioEffect> for AudioEffectChorus
[src]
impl SubClass<Object> for AudioEffectChorus
[src]
impl SubClass<Reference> for AudioEffectChorus
[src]
impl SubClass<Resource> for AudioEffectChorus
[src]
Auto Trait Implementations
impl RefUnwindSafe for AudioEffectChorus
impl !Send for AudioEffectChorus
impl !Sync for AudioEffectChorus
impl Unpin for AudioEffectChorus
impl UnwindSafe for AudioEffectChorus
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,