Struct gdnative::api::AudioEffectDelay

pub struct AudioEffectDelay { /* fields omitted */ }

core class AudioEffectDelay 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

AudioEffectDelay 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 AudioEffectDelay

pub fn new() -> Ref<AudioEffectDelay, 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

Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1.

pub fn feedback_delay_ms(&self) -> f64

Feedback delay time in milliseconds.

pub fn feedback_level_db(&self) -> f64

Sound level for [code]tap1[/code].

pub fn feedback_lowpass(&self) -> f64

Low-pass filter for feedback, in Hz. Frequencies below this value are filtered out of the source signal.

pub fn tap1_delay_ms(&self) -> f64

[code]tap1[/code] delay time in milliseconds.

pub fn tap1_level_db(&self) -> f64

Sound level for [code]tap1[/code].

pub fn tap1_pan(&self) -> f64

Pan position for [code]tap1[/code]. Value can range from -1 (fully left) to 1 (fully right).

pub fn tap2_delay_ms(&self) -> f64

[b]Tap2[/b] delay time in milliseconds.

pub fn tap2_level_db(&self) -> f64

Sound level for [code]tap2[/code].

pub fn tap2_pan(&self) -> f64

Pan position for [code]tap2[/code]. Value can range from -1 (fully left) to 1 (fully right).

pub fn is_feedback_active(&self) -> bool

If [code]true[/code], feedback is enabled.

pub fn is_tap1_active(&self) -> bool

If [code]true[/code], [code]tap1[/code] will be enabled.

pub fn is_tap2_active(&self) -> bool

If [code]true[/code], [code]tap2[/code] will be enabled.

pub fn set_dry(&self, amount: f64)

Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1.

pub fn set_feedback_active(&self, amount: bool)

If [code]true[/code], feedback is enabled.

pub fn set_feedback_delay_ms(&self, amount: f64)

Feedback delay time in milliseconds.

pub fn set_feedback_level_db(&self, amount: f64)

Sound level for [code]tap1[/code].

pub fn set_feedback_lowpass(&self, amount: f64)

Low-pass filter for feedback, in Hz. Frequencies below this value are filtered out of the source signal.

pub fn set_tap1_active(&self, amount: bool)

If [code]true[/code], [code]tap1[/code] will be enabled.

pub fn set_tap1_delay_ms(&self, amount: f64)

[code]tap1[/code] delay time in milliseconds.

pub fn set_tap1_level_db(&self, amount: f64)

Sound level for [code]tap1[/code].

pub fn set_tap1_pan(&self, amount: f64)

Pan position for [code]tap1[/code]. Value can range from -1 (fully left) to 1 (fully right).

pub fn set_tap2_active(&self, amount: bool)

If [code]true[/code], [code]tap2[/code] will be enabled.

pub fn set_tap2_delay_ms(&self, amount: f64)

[b]Tap2[/b] delay time in milliseconds.

pub fn set_tap2_level_db(&self, amount: f64)

Sound level for [code]tap2[/code].

pub fn set_tap2_pan(&self, amount: f64)

Pan position for [code]tap2[/code]. Value can range from -1 (fully left) to 1 (fully right).

Trait Implementations

impl Debug for AudioEffectDelay

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

Formats the value using the given formatter.

impl Deref for AudioEffectDelay

type Target = AudioEffect

The resulting type after dereferencing.

fn deref(&self) -> &AudioEffect

Dereferences the value.

impl DerefMut for AudioEffectDelay

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

Mutably dereferences the value.

impl GodotObject for AudioEffectDelay

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 AudioEffectDelay

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

impl SubClass<AudioEffect> for AudioEffectDelay

impl SubClass<Object> for AudioEffectDelay

impl SubClass<Reference> for AudioEffectDelay

impl SubClass<Resource> for AudioEffectDelay