Struct gdnative::api::AudioStreamPlayer2D

pub struct AudioStreamPlayer2D { /* fields omitted */ }

core class AudioStreamPlayer2D inherits Node2D (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

AudioStreamPlayer2D is a reference-only type. Persistent references can only exist in the unsafe Ref<AudioStreamPlayer2D> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ptr::free, or Ptr::queue_free if it is a Node.

Class hierarchy

AudioStreamPlayer2D inherits methods from:

• Node2D
• CanvasItem
• Node
• 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 AudioStreamPlayer2D

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

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ptr::free, or preferably Ptr::queue_free if it is a Node.

pub fn area_mask(&self) -> i64

pub fn attenuation(&self) -> f64

pub fn bus(&self) -> GodotString

pub fn max_distance(&self) -> f64

pub fn pitch_scale(&self) -> f64

pub fn get_playback_position(&self) -> f64

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

pub fn stream_paused(&self) -> bool

pub fn get_stream_playback(&self) -> Option<Ref<AudioStreamPlayback, Shared>>

pub fn volume_db(&self) -> f64

pub fn is_autoplay_enabled(&self) -> bool

pub fn is_playing(&self) -> bool

pub fn play(&self, from_position: f64)

pub fn seek(&self, to_position: f64)

pub fn set_area_mask(&self, mask: i64)

pub fn set_attenuation(&self, curve: f64)

pub fn set_autoplay(&self, enable: bool)

pub fn set_bus(&self, bus: impl Into<GodotString>)

pub fn set_max_distance(&self, pixels: f64)

pub fn set_pitch_scale(&self, pitch_scale: f64)

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

pub fn set_stream_paused(&self, pause: bool)

pub fn set_volume_db(&self, volume_db: f64)

pub fn stop(&self)

Methods from Deref<Target = Node2D>

pub fn apply_scale(&self, ratio: Vector2D<f32, UnknownUnit>)

pub fn get_angle_to(&self, point: Vector2D<f32, UnknownUnit>) -> f64

pub fn global_position(&self) -> Vector2D<f32, UnknownUnit>

pub fn global_rotation(&self) -> f64

pub fn global_rotation_degrees(&self) -> f64

pub fn global_scale(&self) -> Vector2D<f32, UnknownUnit>

pub fn position(&self) -> Vector2D<f32, UnknownUnit>

pub fn get_relative_transform_to_parent(
    &self,
    parent: impl AsArg<Node>
) -> Transform2D<f32, UnknownUnit, UnknownUnit>

pub fn rotation(&self) -> f64

pub fn rotation_degrees(&self) -> f64

pub fn scale(&self) -> Vector2D<f32, UnknownUnit>

pub fn z_index(&self) -> i64

pub fn global_translate(&self, offset: Vector2D<f32, UnknownUnit>)

pub fn is_z_relative(&self) -> bool

pub fn look_at(&self, point: Vector2D<f32, UnknownUnit>)

pub fn move_local_x(&self, delta: f64, scaled: bool)

pub fn move_local_y(&self, delta: f64, scaled: bool)

pub fn rotate(&self, radians: f64)

pub fn set_global_position(&self, position: Vector2D<f32, UnknownUnit>)

pub fn set_global_rotation(&self, radians: f64)

pub fn set_global_rotation_degrees(&self, degrees: f64)

pub fn set_global_scale(&self, scale: Vector2D<f32, UnknownUnit>)

pub fn set_global_transform(
    &self,
    xform: Transform2D<f32, UnknownUnit, UnknownUnit>
)

pub fn set_position(&self, position: Vector2D<f32, UnknownUnit>)

pub fn set_rotation(&self, radians: f64)

pub fn set_rotation_degrees(&self, degrees: f64)

pub fn set_scale(&self, scale: Vector2D<f32, UnknownUnit>)

pub fn set_transform(&self, xform: Transform2D<f32, UnknownUnit, UnknownUnit>)

pub fn set_z_as_relative(&self, enable: bool)

pub fn set_z_index(&self, z_index: i64)

pub fn to_global(
    &self,
    local_point: Vector2D<f32, UnknownUnit>
) -> Vector2D<f32, UnknownUnit>

pub fn to_local(
    &self,
    global_point: Vector2D<f32, UnknownUnit>
) -> Vector2D<f32, UnknownUnit>

pub fn translate(&self, offset: Vector2D<f32, UnknownUnit>)

Trait Implementations

impl Debug for AudioStreamPlayer2D

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

Formats the value using the given formatter.

impl Deref for AudioStreamPlayer2D

type Target = Node2D

The resulting type after dereferencing.

fn deref(&self) -> &Node2D

Dereferences the value.

impl DerefMut for AudioStreamPlayer2D

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

Mutably dereferences the value.

impl GodotObject for AudioStreamPlayer2D

type RefKind = ManuallyManaged

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 AudioStreamPlayer2D

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

impl QueueFree for AudioStreamPlayer2D

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for AudioStreamPlayer2D

impl SubClass<Node> for AudioStreamPlayer2D

impl SubClass<Node2D> for AudioStreamPlayer2D

impl SubClass<Object> for AudioStreamPlayer2D