Struct gdnative::api::AudioEffectDistortion

pub struct AudioEffectDistortion { /* fields omitted */ }

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

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

Constants

pub const MODE_ATAN: i64

pub const MODE_CLIP: i64

pub const MODE_LOFI: i64

pub const MODE_OVERDRIVE: i64

pub const MODE_WAVESHAPE: i64

impl AudioEffectDistortion

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

Creates a new instance of this object.

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

pub fn drive(&self) -> f64

pub fn keep_hf_hz(&self) -> f64

pub fn mode(&self) -> Mode

pub fn post_gain(&self) -> f64

pub fn pre_gain(&self) -> f64

pub fn set_drive(&self, drive: f64)

pub fn set_keep_hf_hz(&self, keep_hf_hz: f64)

pub fn set_mode(&self, mode: i64)

pub fn set_post_gain(&self, post_gain: f64)

pub fn set_pre_gain(&self, pre_gain: f64)

Trait Implementations

impl Debug for AudioEffectDistortion

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

Formats the value using the given formatter.

impl Deref for AudioEffectDistortion

type Target = AudioEffect

The resulting type after dereferencing.

fn deref(&self) -> &AudioEffect

Dereferences the value.

impl DerefMut for AudioEffectDistortion

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

Mutably dereferences the value.

impl GodotObject for AudioEffectDistortion

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 AudioEffectDistortion

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

impl SubClass<AudioEffect> for AudioEffectDistortion

impl SubClass<Object> for AudioEffectDistortion

impl SubClass<Reference> for AudioEffectDistortion

impl SubClass<Resource> for AudioEffectDistortion