Struct gdnative::api::AudioStreamRandomPitch

pub struct AudioStreamRandomPitch { /* fields omitted */ }

core class AudioStreamRandomPitch inherits AudioStream (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

AudioStreamRandomPitch inherits methods from:

• AudioStream
• 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 AudioStreamRandomPitch

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

Creates a new instance of this object.

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

pub fn audio_stream(&self) -> Option<Ref<AudioStream, Shared>>

The current [AudioStream].

pub fn random_pitch(&self) -> f64

The intensity of random pitch variation.

pub fn set_audio_stream(&self, stream: impl AsArg<AudioStream>)

The current [AudioStream].

pub fn set_random_pitch(&self, scale: f64)

The intensity of random pitch variation.

Methods from Deref<Target = AudioStream>

pub fn get_length(&self) -> f64

Returns the length of the audio stream in seconds.

Trait Implementations

impl Debug for AudioStreamRandomPitch

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

Formats the value using the given formatter.

impl Deref for AudioStreamRandomPitch

type Target = AudioStream

The resulting type after dereferencing.

fn deref(&self) -> &AudioStream

Dereferences the value.

impl DerefMut for AudioStreamRandomPitch

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

Mutably dereferences the value.

impl GodotObject for AudioStreamRandomPitch

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 AudioStreamRandomPitch

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

impl SubClass<AudioStream> for AudioStreamRandomPitch

impl SubClass<Object> for AudioStreamRandomPitch

impl SubClass<Reference> for AudioStreamRandomPitch

impl SubClass<Resource> for AudioStreamRandomPitch