[−][src]Struct gdnative_bindings::audio_effect_notch_filter::AudioEffectNotchFilter
core class AudioEffectNotchFilter
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
AudioEffectNotchFilter 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 AudioEffectNotchFilter
[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
.
Methods from Deref<Target = AudioEffectFilter>
pub const FILTER_12DB: i64
[src]
pub const FILTER_18DB: i64
[src]
pub const FILTER_24DB: i64
[src]
pub const FILTER_6DB: i64
[src]
pub fn cutoff(&self) -> f64
[src]
Threshold frequency for the filter, in Hz.
pub fn db(&self) -> FilterDb
[src]
pub fn gain(&self) -> f64
[src]
Gain amount of the frequencies after the filter.
pub fn resonance(&self) -> f64
[src]
Amount of boost in the frequency range near the cutoff frequency.
pub fn set_cutoff(&self, freq: f64)
[src]
Threshold frequency for the filter, in Hz.
pub fn set_db(&self, amount: i64)
[src]
pub fn set_gain(&self, amount: f64)
[src]
Gain amount of the frequencies after the filter.
pub fn set_resonance(&self, amount: f64)
[src]
Amount of boost in the frequency range near the cutoff frequency.
Trait Implementations
impl Debug for AudioEffectNotchFilter
[src]
impl Deref for AudioEffectNotchFilter
[src]
type Target = AudioEffectFilter
The resulting type after dereferencing.
fn deref(&self) -> &AudioEffectFilter
[src]
impl DerefMut for AudioEffectNotchFilter
[src]
fn deref_mut(&mut self) -> &mut AudioEffectFilter
[src]
impl GodotObject for AudioEffectNotchFilter
[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 AudioEffectNotchFilter
[src]
impl Sealed for AudioEffectNotchFilter
[src]
impl SubClass<AudioEffect> for AudioEffectNotchFilter
[src]
impl SubClass<AudioEffectFilter> for AudioEffectNotchFilter
[src]
impl SubClass<Object> for AudioEffectNotchFilter
[src]
impl SubClass<Reference> for AudioEffectNotchFilter
[src]
impl SubClass<Resource> for AudioEffectNotchFilter
[src]
Auto Trait Implementations
impl RefUnwindSafe for AudioEffectNotchFilter
impl !Send for AudioEffectNotchFilter
impl !Sync for AudioEffectNotchFilter
impl Unpin for AudioEffectNotchFilter
impl UnwindSafe for AudioEffectNotchFilter
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>,