Struct gdnative_bindings_lily::AudioEffectPhaser [−][src]
pub struct AudioEffectPhaser { /* fields omitted */ }
Expand description
core class AudioEffectPhaser
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
AudioEffectPhaser 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
.
Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4.
Output percent of modified sound. Value can range from 0.1 to 0.9.
Determines the maximum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
Determines the minimum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range.
Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4.
Output percent of modified sound. Value can range from 0.1 to 0.9.
Determines the maximum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
Determines the minimum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range.
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 AudioEffectPhaser
impl !Send for AudioEffectPhaser
impl !Sync for AudioEffectPhaser
impl Unpin for AudioEffectPhaser
impl UnwindSafe for AudioEffectPhaser