Struct gdnative::api::AudioEffectChorus

pub struct AudioEffectChorus { /* fields omitted */ }

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:

• AudioEffect
• Resource
• Reference
• Object

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

pub fn new() -> Ref<AudioEffectChorus, Unique>

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

The effect's raw signal.

pub fn voice_count(&self) -> i64

The amount of voices in the effect.

pub fn voice_cutoff_hz(&self, voice_idx: i64) -> f64

The voice's cutoff frequency.

pub fn voice_delay_ms(&self, voice_idx: i64) -> f64

The voice's signal delay.

pub fn voice_depth_ms(&self, voice_idx: i64) -> f64

The voice filter's depth.

pub fn voice_level_db(&self, voice_idx: i64) -> f64

The voice's volume.

pub fn voice_pan(&self, voice_idx: i64) -> f64

The voice's pan level.

pub fn voice_rate_hz(&self, voice_idx: i64) -> f64

The voice's filter rate.

pub fn wet(&self) -> f64

The effect's processed signal.

pub fn set_dry(&self, amount: f64)

The effect's raw signal.

pub fn set_voice_count(&self, voices: i64)

The amount of voices in the effect.

pub fn set_voice_cutoff_hz(&self, voice_idx: i64, cutoff_hz: f64)

The voice's cutoff frequency.

pub fn set_voice_delay_ms(&self, voice_idx: i64, delay_ms: f64)

The voice's signal delay.

pub fn set_voice_depth_ms(&self, voice_idx: i64, depth_ms: f64)

The voice filter's depth.

pub fn set_voice_level_db(&self, voice_idx: i64, level_db: f64)

The voice's volume.

pub fn set_voice_pan(&self, voice_idx: i64, pan: f64)

The voice's pan level.

pub fn set_voice_rate_hz(&self, voice_idx: i64, rate_hz: f64)

The voice's filter rate.

pub fn set_wet(&self, amount: f64)

The effect's processed signal.

Trait Implementations

impl Debug for AudioEffectChorus

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for AudioEffectChorus

type Target = AudioEffect

The resulting type after dereferencing.

fn deref(&self) -> &AudioEffect

Dereferences the value.

impl DerefMut for AudioEffectChorus

fn deref_mut(&mut self) -> &mut AudioEffect

Mutably dereferences the value.

impl GodotObject for AudioEffectChorus

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.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for AudioEffectChorus

fn construct() -> Ref<AudioEffectChorus, Unique>

impl SubClass<AudioEffect> for AudioEffectChorus

impl SubClass<Object> for AudioEffectChorus

impl SubClass<Reference> for AudioEffectChorus

impl SubClass<Resource> for AudioEffectChorus