Struct gdnative::AudioStreamPlayer3D

pub struct AudioStreamPlayer3D { /* fields omitted */ }

core class AudioStreamPlayer3D inherits Spatial (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.

AudioStreamPlayer3D is an unsafe pointer, and all of its methods are unsafe.

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 AudioStreamPlayer3D::free.

Class hierarchy

AudioStreamPlayer3D inherits methods from:

• Spatial
• Node
• Object

Methods

impl AudioStreamPlayer3D

Constants

pub const ATTENUATION_LOGARITHMIC: i64

pub const ATTENUATION_INVERSE_DISTANCE: i64

pub const ATTENUATION_INVERSE_SQUARE_DISTANCE: i64

pub const ATTENUATION_DISABLED: i64

pub const OUT_OF_RANGE_MIX: i64

pub const DOPPLER_TRACKING_PHYSICS_STEP: i64

pub const DOPPLER_TRACKING_DISABLED: i64

pub const DOPPLER_TRACKING_IDLE_STEP: i64

pub const OUT_OF_RANGE_PAUSE: i64

impl AudioStreamPlayer3D

pub fn new() -> AudioStreamPlayer3D

Constructor.

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 AudioStreamPlayer3D::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn _bus_layout_changed(&mut self)

pub unsafe fn _is_active(&self) -> bool

pub unsafe fn _set_playing(&mut self, enable: bool)

pub unsafe fn get_area_mask(&self) -> i64

pub unsafe fn get_attenuation_filter_cutoff_hz(&self) -> f64

pub unsafe fn get_attenuation_filter_db(&self) -> f64

pub unsafe fn get_attenuation_model(
    &self
) -> AudioStreamPlayer3DAttenuationModel

pub unsafe fn get_bus(&self) -> GodotString

pub unsafe fn get_doppler_tracking(&self) -> AudioStreamPlayer3DDopplerTracking

pub unsafe fn get_emission_angle(&self) -> f64

pub unsafe fn get_emission_angle_filter_attenuation_db(&self) -> f64

pub unsafe fn get_max_db(&self) -> f64

pub unsafe fn get_max_distance(&self) -> f64

pub unsafe fn get_out_of_range_mode(&self) -> AudioStreamPlayer3DOutOfRangeMode

pub unsafe fn get_pitch_scale(&self) -> f64

pub unsafe fn get_playback_position(&mut self) -> f64

pub unsafe fn get_stream(&self) -> Option<AudioStream>

pub unsafe fn get_stream_paused(&self) -> bool

pub unsafe fn get_stream_playback(&mut self) -> Option<AudioStreamPlayback>

pub unsafe fn get_unit_db(&self) -> f64

pub unsafe fn get_unit_size(&self) -> f64

pub unsafe fn is_autoplay_enabled(&mut self) -> bool

pub unsafe fn is_emission_angle_enabled(&self) -> bool

pub unsafe fn is_playing(&self) -> bool

pub unsafe fn play(&mut self, from_position: f64)

pub unsafe fn seek(&mut self, to_position: f64)

pub unsafe fn set_area_mask(&mut self, mask: i64)

pub unsafe fn set_attenuation_filter_cutoff_hz(&mut self, degrees: f64)

pub unsafe fn set_attenuation_filter_db(&mut self, db: f64)

pub unsafe fn set_attenuation_model(&mut self, model: i64)

pub unsafe fn set_autoplay(&mut self, enable: bool)

pub unsafe fn set_bus(&mut self, bus: GodotString)

pub unsafe fn set_doppler_tracking(&mut self, mode: i64)

pub unsafe fn set_emission_angle(&mut self, degrees: f64)

pub unsafe fn set_emission_angle_enabled(&mut self, enabled: bool)

pub unsafe fn set_emission_angle_filter_attenuation_db(&mut self, db: f64)

pub unsafe fn set_max_db(&mut self, max_db: f64)

pub unsafe fn set_max_distance(&mut self, metres: f64)

pub unsafe fn set_out_of_range_mode(&mut self, mode: i64)

pub unsafe fn set_pitch_scale(&mut self, pitch_scale: f64)

pub unsafe fn set_stream(&mut self, stream: Option<AudioStream>)

pub unsafe fn set_stream_paused(&mut self, pause: bool)

pub unsafe fn set_unit_db(&mut self, unit_db: f64)

pub unsafe fn set_unit_size(&mut self, unit_size: f64)

pub unsafe fn stop(&mut self)

pub unsafe fn to_spatial(&self) -> Spatial

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Methods from Deref<Target = Spatial>

pub const NOTIFICATION_TRANSFORM_CHANGED: i64

pub const NOTIFICATION_EXIT_WORLD: i64

pub const NOTIFICATION_ENTER_WORLD: i64

pub const NOTIFICATION_VISIBILITY_CHANGED: i64

pub unsafe fn _update_gizmo(&mut self)

pub unsafe fn force_update_transform(&mut self)

pub unsafe fn get_gizmo(&self) -> Option<SpatialGizmo>

pub unsafe fn get_global_transform(&self) -> Transform

pub unsafe fn get_parent_spatial(&self) -> Option<Spatial>

pub unsafe fn get_rotation(&self) -> Vector3D<f32, UnknownUnit>

pub unsafe fn get_rotation_degrees(&self) -> Vector3D<f32, UnknownUnit>

pub unsafe fn get_scale(&self) -> Vector3D<f32, UnknownUnit>

pub unsafe fn get_transform(&self) -> Transform

pub unsafe fn get_translation(&self) -> Vector3D<f32, UnknownUnit>

pub unsafe fn get_world(&self) -> Option<World>

pub unsafe fn global_rotate(
    &mut self,
    axis: Vector3D<f32, UnknownUnit>,
    angle: f64
)

pub unsafe fn global_scale(&mut self, scale: Vector3D<f32, UnknownUnit>)

pub unsafe fn global_translate(&mut self, offset: Vector3D<f32, UnknownUnit>)

pub unsafe fn hide(&mut self)

pub unsafe fn is_local_transform_notification_enabled(&self) -> bool

pub unsafe fn is_scale_disabled(&self) -> bool

pub unsafe fn is_set_as_toplevel(&self) -> bool

pub unsafe fn is_transform_notification_enabled(&self) -> bool

pub unsafe fn is_visible(&self) -> bool

pub unsafe fn is_visible_in_tree(&self) -> bool

pub unsafe fn look_at(
    &mut self,
    target: Vector3D<f32, UnknownUnit>,
    up: Vector3D<f32, UnknownUnit>
)

pub unsafe fn look_at_from_position(
    &mut self,
    position: Vector3D<f32, UnknownUnit>,
    target: Vector3D<f32, UnknownUnit>,
    up: Vector3D<f32, UnknownUnit>
)

pub unsafe fn orthonormalize(&mut self)

pub unsafe fn rotate(&mut self, axis: Vector3D<f32, UnknownUnit>, angle: f64)

pub unsafe fn rotate_object_local(
    &mut self,
    axis: Vector3D<f32, UnknownUnit>,
    angle: f64
)

pub unsafe fn rotate_x(&mut self, angle: f64)

pub unsafe fn rotate_y(&mut self, angle: f64)

pub unsafe fn rotate_z(&mut self, angle: f64)

pub unsafe fn scale_object_local(&mut self, scale: Vector3D<f32, UnknownUnit>)

pub unsafe fn set_as_toplevel(&mut self, enable: bool)

pub unsafe fn set_disable_scale(&mut self, disable: bool)

pub unsafe fn set_gizmo(&mut self, gizmo: Option<SpatialGizmo>)

pub unsafe fn set_global_transform(&mut self, global: Transform)

pub unsafe fn set_identity(&mut self)

pub unsafe fn set_ignore_transform_notification(&mut self, enabled: bool)

pub unsafe fn set_notify_local_transform(&mut self, enable: bool)

pub unsafe fn set_notify_transform(&mut self, enable: bool)

pub unsafe fn set_rotation(&mut self, euler: Vector3D<f32, UnknownUnit>)

pub unsafe fn set_rotation_degrees(
    &mut self,
    euler_degrees: Vector3D<f32, UnknownUnit>
)

pub unsafe fn set_scale(&mut self, scale: Vector3D<f32, UnknownUnit>)

pub unsafe fn set_transform(&mut self, local: Transform)

pub unsafe fn set_translation(
    &mut self,
    translation: Vector3D<f32, UnknownUnit>
)

pub unsafe fn set_visible(&mut self, visible: bool)

pub unsafe fn show(&mut self)

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

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

pub unsafe fn translate(&mut self, offset: Vector3D<f32, UnknownUnit>)

pub unsafe fn translate_object_local(
    &mut self,
    offset: Vector3D<f32, UnknownUnit>
)

pub unsafe fn update_gizmo(&mut self)

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for AudioStreamPlayer3D

fn clone(&self) -> AudioStreamPlayer3D

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for AudioStreamPlayer3D

impl Debug for AudioStreamPlayer3D

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

Formats the value using the given formatter.

impl Deref for AudioStreamPlayer3D

type Target = Spatial

The resulting type after dereferencing.

fn deref(&self) -> &Spatial

Dereferences the value.

impl DerefMut for AudioStreamPlayer3D

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

Mutably dereferences the value.

impl Free for AudioStreamPlayer3D

unsafe fn godot_free(self)

impl FromVariant for AudioStreamPlayer3D

fn from_variant(
    variant: &Variant
) -> Result<AudioStreamPlayer3D, FromVariantError>

impl GodotObject for AudioStreamPlayer3D

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> AudioStreamPlayer3D

unsafe fn from_return_position_sys(obj: *mut c_void) -> AudioStreamPlayer3D

unsafe fn to_sys(&self) -> *mut c_void

impl Instanciable for AudioStreamPlayer3D

fn construct() -> AudioStreamPlayer3D

impl QueueFree for AudioStreamPlayer3D

unsafe fn godot_queue_free(&mut self)

impl ToVariant for AudioStreamPlayer3D

fn to_variant(&self) -> Variant