Struct gdnative::api::AudioEffectReverb

pub struct AudioEffectReverb { /* fields omitted */ }

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

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

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

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn damping(&self) -> f64

Defines how reflective the imaginary room's walls are. Value can range from 0 to 1.

pub fn dry(&self) -> f64

Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1.

pub fn hpf(&self) -> f64

High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1.

pub fn predelay_feedback(&self) -> f64

Output percent of predelay. Value can range from 0 to 1.

pub fn predelay_msec(&self) -> f64

Time between the original signal and the early reflections of the reverb signal, in milliseconds.

pub fn room_size(&self) -> f64

Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1.

pub fn spread(&self) -> f64

Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1.

pub fn wet(&self) -> f64

Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1.

pub fn set_damping(&self, amount: f64)

Defines how reflective the imaginary room's walls are. Value can range from 0 to 1.

pub fn set_dry(&self, amount: f64)

Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1.

pub fn set_hpf(&self, amount: f64)

High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1.

pub fn set_predelay_feedback(&self, feedback: f64)

Output percent of predelay. Value can range from 0 to 1.

pub fn set_predelay_msec(&self, msec: f64)

Time between the original signal and the early reflections of the reverb signal, in milliseconds.

pub fn set_room_size(&self, size: f64)

Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1.

pub fn set_spread(&self, amount: f64)

Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1.

pub fn set_wet(&self, amount: f64)

Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1.

Trait Implementations

impl Debug for AudioEffectReverb

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

Formats the value using the given formatter.

impl Deref for AudioEffectReverb

type Target = AudioEffect

The resulting type after dereferencing.

fn deref(&self) -> &AudioEffect

Dereferences the value.

impl DerefMut for AudioEffectReverb

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

Mutably dereferences the value.

impl GodotObject for AudioEffectReverb

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 AudioEffectReverb

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

impl SubClass<AudioEffect> for AudioEffectReverb

impl SubClass<Object> for AudioEffectReverb

impl SubClass<Reference> for AudioEffectReverb

impl SubClass<Resource> for AudioEffectReverb