Struct gdnative::api::AudioEffectLowPassFilter

pub struct AudioEffectLowPassFilter { /* fields omitted */ }

core class AudioEffectLowPassFilter inherits AudioEffectFilter (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

AudioEffectLowPassFilter inherits methods from:

• AudioEffectFilter
• 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 AudioEffectLowPassFilter

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

Creates a new instance of this object.

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

Methods from Deref<Target = AudioEffectFilter>

pub const FILTER_12DB: i64

pub const FILTER_18DB: i64

pub const FILTER_24DB: i64

pub const FILTER_6DB: i64

pub fn cutoff(&self) -> f64

Threshold frequency for the filter, in Hz.

pub fn db(&self) -> FilterDb

pub fn gain(&self) -> f64

Gain amount of the frequencies after the filter.

pub fn resonance(&self) -> f64

Amount of boost in the frequency range near the cutoff frequency.

pub fn set_cutoff(&self, freq: f64)

Threshold frequency for the filter, in Hz.

pub fn set_db(&self, amount: i64)

pub fn set_gain(&self, amount: f64)

Gain amount of the frequencies after the filter.

pub fn set_resonance(&self, amount: f64)

Amount of boost in the frequency range near the cutoff frequency.

Trait Implementations

impl Debug for AudioEffectLowPassFilter

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

Formats the value using the given formatter.

impl Deref for AudioEffectLowPassFilter

type Target = AudioEffectFilter

The resulting type after dereferencing.

fn deref(&self) -> &AudioEffectFilter

Dereferences the value.

impl DerefMut for AudioEffectLowPassFilter

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

Mutably dereferences the value.

impl GodotObject for AudioEffectLowPassFilter

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 AudioEffectLowPassFilter

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

impl SubClass<AudioEffect> for AudioEffectLowPassFilter

impl SubClass<AudioEffectFilter> for AudioEffectLowPassFilter

impl SubClass<Object> for AudioEffectLowPassFilter

impl SubClass<Reference> for AudioEffectLowPassFilter

impl SubClass<Resource> for AudioEffectLowPassFilter