Struct gdnative::api::AudioEffectPhaser

pub struct AudioEffectPhaser { /* fields omitted */ }

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:

• 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 AudioEffectPhaser

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

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

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

Output percent of modified sound. Value can range from 0.1 to 0.9.

pub fn range_max_hz(&self) -> f64

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

Determines the minimum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.

pub fn rate_hz(&self) -> f64

Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range.

pub fn set_depth(&self, depth: f64)

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)

Output percent of modified sound. Value can range from 0.1 to 0.9.

pub fn set_range_max_hz(&self, hz: f64)

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)

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)

Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range.

Trait Implementations

impl Debug for AudioEffectPhaser

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

Formats the value using the given formatter.

impl Deref for AudioEffectPhaser

type Target = AudioEffect

The resulting type after dereferencing.

fn deref(&self) -> &AudioEffect

Dereferences the value.

impl DerefMut for AudioEffectPhaser

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

Mutably dereferences the value.

impl GodotObject for AudioEffectPhaser

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 AudioEffectPhaser

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

impl SubClass<AudioEffect> for AudioEffectPhaser

impl SubClass<Object> for AudioEffectPhaser

impl SubClass<Reference> for AudioEffectPhaser

impl SubClass<Resource> for AudioEffectPhaser