Struct gdnative_bindings_lily::AudioEffectDelay [−][src]
pub struct AudioEffectDelay { /* fields omitted */ }
Expand description
core class AudioEffectDelay
inherits AudioEffect
(reference counted).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
AudioEffectDelay 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
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1.
Feedback delay time in milliseconds.
Sound level for tap1
.
Low-pass filter for feedback, in Hz. Frequencies below this value are filtered out of the source signal.
tap1
delay time in milliseconds.
Sound level for tap1
.
Pan position for tap1
. Value can range from -1 (fully left) to 1 (fully right).
Tap2 delay time in milliseconds.
Sound level for tap2
.
Pan position for tap2
. Value can range from -1 (fully left) to 1 (fully right).
If true
, feedback is enabled.
If true
, tap1
will be enabled.
If true
, tap2
will be enabled.
Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1.
If true
, feedback is enabled.
Feedback delay time in milliseconds.
Sound level for tap1
.
Low-pass filter for feedback, in Hz. Frequencies below this value are filtered out of the source signal.
If true
, tap1
will be enabled.
tap1
delay time in milliseconds.
Sound level for tap1
.
Pan position for tap1
. Value can range from -1 (fully left) to 1 (fully right).
If true
, tap2
will be enabled.
Tap2 delay time in milliseconds.
Sound level for tap2
.
Pan position for tap2
. Value can range from -1 (fully left) to 1 (fully right).
Trait Implementations
type Target = AudioEffect
type Target = AudioEffect
The resulting type after dereferencing.
Dereferences the value.
Mutably dereferences the value.
type RefKind = RefCounted
type RefKind = RefCounted
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
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. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for AudioEffectDelay
impl !Send for AudioEffectDelay
impl !Sync for AudioEffectDelay
impl Unpin for AudioEffectDelay
impl UnwindSafe for AudioEffectDelay