Struct gdnative_bindings::AudioEffectLimiter

pub struct AudioEffectLimiter { /* fields omitted */ }

core class AudioEffectLimiter 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

AudioEffectLimiter 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 AudioEffectLimiter

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

Creates a new instance of this object.

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

pub fn ceiling_db(&self) -> f64

The waveform's maximum allowed value, in decibels. Value can range from -20 to -0.1.

pub fn soft_clip_db(&self) -> f64

Applies a gain to the limited waves, in decibels. Value can range from 0 to 6.

pub fn soft_clip_ratio(&self) -> f64

pub fn threshold_db(&self) -> f64

Threshold from which the limiter begins to be active, in decibels. Value can range from -30 to 0.

pub fn set_ceiling_db(&self, ceiling: f64)

The waveform's maximum allowed value, in decibels. Value can range from -20 to -0.1.

pub fn set_soft_clip_db(&self, soft_clip: f64)

Applies a gain to the limited waves, in decibels. Value can range from 0 to 6.

pub fn set_soft_clip_ratio(&self, soft_clip: f64)

pub fn set_threshold_db(&self, threshold: f64)

Threshold from which the limiter begins to be active, in decibels. Value can range from -30 to 0.

Trait Implementations

impl Debug for AudioEffectLimiter

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

Formats the value using the given formatter.

impl Deref for AudioEffectLimiter

type Target = AudioEffect

The resulting type after dereferencing.

fn deref(&self) -> &AudioEffect

Dereferences the value.

impl DerefMut for AudioEffectLimiter

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

Mutably dereferences the value.

impl GodotObject for AudioEffectLimiter

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 AudioEffectLimiter

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

impl Sealed for AudioEffectLimiter

impl SubClass<AudioEffect> for AudioEffectLimiter

impl SubClass<Object> for AudioEffectLimiter

impl SubClass<Reference> for AudioEffectLimiter

impl SubClass<Resource> for AudioEffectLimiter