Struct gdnative::api::AudioEffect

pub struct AudioEffect { /* fields omitted */ }

core class AudioEffect inherits Resource (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

AudioEffect inherits methods from:

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

Methods from Deref<Target = Resource>

pub fn duplicate(&self, subresources: bool) -> Option<Ref<Resource, Shared>>

pub fn get_local_scene(&self) -> Option<Ref<Node, Shared>>

pub fn name(&self) -> GodotString

pub fn path(&self) -> GodotString

pub fn get_rid(&self) -> Rid

pub fn is_local_to_scene(&self) -> bool

pub fn set_local_to_scene(&self, enable: bool)

pub fn set_name(&self, name: impl Into<GodotString>)

pub fn set_path(&self, path: impl Into<GodotString>)

pub fn setup_local_to_scene(&self)

pub fn take_over_path(&self, path: impl Into<GodotString>)

Trait Implementations

impl Debug for AudioEffect

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

Formats the value using the given formatter.

impl Deref for AudioEffect

type Target = Resource

The resulting type after dereferencing.

fn deref(&self) -> &Resource

Dereferences the value.

impl DerefMut for AudioEffect

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

Mutably dereferences the value.

impl GodotObject for AudioEffect

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 SubClass<AudioEffect> for AudioEffectEQ10

impl SubClass<AudioEffect> for AudioEffectDelay

impl SubClass<AudioEffect> for AudioEffectRecord

impl SubClass<AudioEffect> for AudioEffectPhaser

impl SubClass<AudioEffect> for AudioEffectEQ21

impl SubClass<AudioEffect> for AudioEffectBandLimitFilter

impl SubClass<AudioEffect> for AudioEffectDistortion

impl SubClass<AudioEffect> for AudioEffectPitchShift

impl SubClass<AudioEffect> for AudioEffectReverb

impl SubClass<AudioEffect> for AudioEffectBandPassFilter

impl SubClass<AudioEffect> for AudioEffectFilter

impl SubClass<AudioEffect> for AudioEffectLimiter

impl SubClass<AudioEffect> for AudioEffectEQ

impl SubClass<AudioEffect> for AudioEffectCompressor

impl SubClass<AudioEffect> for AudioEffectLowShelfFilter

impl SubClass<AudioEffect> for AudioEffectSpectrumAnalyzer

impl SubClass<AudioEffect> for AudioEffectNotchFilter

impl SubClass<AudioEffect> for AudioEffectHighShelfFilter

impl SubClass<AudioEffect> for AudioEffectAmplify

impl SubClass<AudioEffect> for AudioEffectLowPassFilter

impl SubClass<AudioEffect> for AudioEffectEQ6

impl SubClass<AudioEffect> for AudioEffectChorus

impl SubClass<AudioEffect> for AudioEffectPanner

impl SubClass<AudioEffect> for AudioEffectHighPassFilter

impl SubClass<AudioEffect> for AudioEffectStereoEnhance

impl SubClass<Object> for AudioEffect

impl SubClass<Reference> for AudioEffect

impl SubClass<Resource> for AudioEffect