[−][src]Struct gdnative_bindings::AudioEffectPhaser
core class AudioEffectPhaser
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
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
impl AudioEffectPhaser
[src]
pub fn new() -> Ref<Self, Unique>
[src]
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
pub fn depth(&self) -> f64
[src]
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.
pub fn feedback(&self) -> f64
[src]
Output percent of modified sound. Value can range from 0.1 to 0.9.
pub fn range_max_hz(&self) -> f64
[src]
Determines the maximum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
pub fn range_min_hz(&self) -> f64
[src]
Determines the minimum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
pub fn rate_hz(&self) -> f64
[src]
Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range.
pub fn set_depth(&self, depth: f64)
[src]
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.
pub fn set_feedback(&self, fbk: f64)
[src]
Output percent of modified sound. Value can range from 0.1 to 0.9.
pub fn set_range_max_hz(&self, hz: f64)
[src]
Determines the maximum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
pub fn set_range_min_hz(&self, hz: f64)
[src]
Determines the minimum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
pub fn set_rate_hz(&self, hz: f64)
[src]
Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range.
Trait Implementations
impl Debug for AudioEffectPhaser
[src]
impl Deref for AudioEffectPhaser
[src]
type Target = AudioEffect
The resulting type after dereferencing.
fn deref(&self) -> &AudioEffect
[src]
impl DerefMut for AudioEffectPhaser
[src]
fn deref_mut(&mut self) -> &mut AudioEffect
[src]
impl GodotObject for AudioEffectPhaser
[src]
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. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for AudioEffectPhaser
[src]
impl Sealed for AudioEffectPhaser
[src]
impl SubClass<AudioEffect> for AudioEffectPhaser
[src]
impl SubClass<Object> for AudioEffectPhaser
[src]
impl SubClass<Reference> for AudioEffectPhaser
[src]
impl SubClass<Resource> for AudioEffectPhaser
[src]
Auto Trait Implementations
impl RefUnwindSafe for AudioEffectPhaser
impl !Send for AudioEffectPhaser
impl !Sync for AudioEffectPhaser
impl Unpin for AudioEffectPhaser
impl UnwindSafe for AudioEffectPhaser
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,