[−][src]Struct gdnative_bindings::Particles

pub struct Particles { /* fields omitted */ }

core class Particles inherits GeometryInstance (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.

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

Class hierarchy

Particles inherits methods from:

Methods

`impl Particles`[src]

Constants

`pub const DRAW_ORDER_INDEX: i64`[src]

`pub const DRAW_ORDER_LIFETIME: i64`[src]

`pub const MAX_DRAW_PASSES: i64`[src]

`pub const DRAW_ORDER_VIEW_DEPTH: i64`[src]

`impl Particles`[src]

`pub fn new() -> Self`[src]

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

`pub unsafe fn free(self)`[src]

Manually deallocate the object.

`pub unsafe fn capture_aabb(&self) -> Aabb`[src]

`pub unsafe fn get_amount(&self) -> i64`[src]

`pub unsafe fn get_draw_order(&self) -> ParticlesDrawOrder`[src]

`pub unsafe fn get_draw_pass_mesh(&self, pass: i64) -> Option<Mesh>`[src]

`pub unsafe fn get_draw_passes(&self) -> i64`[src]

`pub unsafe fn get_explosiveness_ratio(&self) -> f64`[src]

`pub unsafe fn get_fixed_fps(&self) -> i64`[src]

`pub unsafe fn get_fractional_delta(&self) -> bool`[src]

`pub unsafe fn get_lifetime(&self) -> f64`[src]

`pub unsafe fn get_one_shot(&self) -> bool`[src]

`pub unsafe fn get_pre_process_time(&self) -> f64`[src]

`pub unsafe fn get_process_material(&self) -> Option<Material>`[src]

`pub unsafe fn get_randomness_ratio(&self) -> f64`[src]

`pub unsafe fn get_speed_scale(&self) -> f64`[src]

`pub unsafe fn get_use_local_coordinates(&self) -> bool`[src]

`pub unsafe fn get_visibility_aabb(&self) -> Aabb`[src]

`pub unsafe fn is_emitting(&self) -> bool`[src]

`pub unsafe fn restart(&mut self)`[src]

`pub unsafe fn set_amount(&mut self, amount: i64)`[src]

`pub unsafe fn set_draw_order(&mut self, order: i64)`[src]

`pub unsafe fn set_draw_pass_mesh(&mut self, pass: i64, mesh: Option<Mesh>)`[src]

`pub unsafe fn set_draw_passes(&mut self, passes: i64)`[src]

`pub unsafe fn set_emitting(&mut self, emitting: bool)`[src]

`pub unsafe fn set_explosiveness_ratio(&mut self, ratio: f64)`[src]

`pub unsafe fn set_fixed_fps(&mut self, fps: i64)`[src]

`pub unsafe fn set_fractional_delta(&mut self, enable: bool)`[src]

`pub unsafe fn set_lifetime(&mut self, secs: f64)`[src]

`pub unsafe fn set_one_shot(&mut self, enable: bool)`[src]

`pub unsafe fn set_pre_process_time(&mut self, secs: f64)`[src]

`pub unsafe fn set_process_material(&mut self, material: Option<Material>)`[src]

`pub unsafe fn set_randomness_ratio(&mut self, ratio: f64)`[src]

`pub unsafe fn set_speed_scale(&mut self, scale: f64)`[src]

`pub unsafe fn set_use_local_coordinates(&mut self, enable: bool)`[src]

`pub unsafe fn set_visibility_aabb(&mut self, aabb: Aabb)`[src]

`pub unsafe fn to_geometry_instance(&self) -> GeometryInstance`[src]

Up-cast.

`pub unsafe fn to_visual_instance(&self) -> VisualInstance`[src]

Up-cast.

`pub unsafe fn to_spatial(&self) -> Spatial`[src]

Up-cast.

`pub unsafe fn to_node(&self) -> Node`[src]

Up-cast.

`pub unsafe fn to_object(&self) -> Object`[src]

Up-cast.

`pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>`[src]

Generic dynamic cast.

Methods from Deref<Target = GeometryInstance>

`pub const SHADOW_CASTING_SETTING_SHADOWS_ONLY: i64`[src]

`pub const FLAG_MAX: i64`[src]

`pub const FLAG_USE_BAKED_LIGHT: i64`[src]

`pub const SHADOW_CASTING_SETTING_DOUBLE_SIDED: i64`[src]

`pub const SHADOW_CASTING_SETTING_OFF: i64`[src]

`pub const SHADOW_CASTING_SETTING_ON: i64`[src]

`pub unsafe fn get_cast_shadows_setting( &self ) -> GeometryInstanceShadowCastingSetting`[src]

`pub unsafe fn get_extra_cull_margin(&self) -> f64`[src]

`pub unsafe fn get_flag(&self, flag: i64) -> bool`[src]

`pub unsafe fn get_lod_max_distance(&self) -> f64`[src]

`pub unsafe fn get_lod_max_hysteresis(&self) -> f64`[src]

`pub unsafe fn get_lod_min_distance(&self) -> f64`[src]

`pub unsafe fn get_lod_min_hysteresis(&self) -> f64`[src]

`pub unsafe fn get_material_override(&self) -> Option<Material>`[src]

`pub unsafe fn set_cast_shadows_setting(&mut self, shadow_casting_setting: i64)`[src]

`pub unsafe fn set_extra_cull_margin(&mut self, margin: f64)`[src]

`pub unsafe fn set_flag(&mut self, flag: i64, value: bool)`[src]

`pub unsafe fn set_lod_max_distance(&mut self, mode: f64)`[src]

`pub unsafe fn set_lod_max_hysteresis(&mut self, mode: f64)`[src]

`pub unsafe fn set_lod_min_distance(&mut self, mode: f64)`[src]

`pub unsafe fn set_lod_min_hysteresis(&mut self, mode: f64)`[src]

`pub unsafe fn set_material_override(&mut self, material: Option<Material>)`[src]

`pub unsafe fn to_visual_instance(&self) -> VisualInstance`[src]

Up-cast.

`pub unsafe fn to_spatial(&self) -> Spatial`[src]

Up-cast.

`pub unsafe fn to_node(&self) -> Node`[src]

Up-cast.

`pub unsafe fn to_object(&self) -> Object`[src]

Up-cast.

`pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>`[src]

Generic dynamic cast.

Trait Implementations

`impl Clone for Particles`[src]

`fn clone(&self) -> Particles`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Copy for Particles`[src]

`impl Debug for Particles`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Deref for Particles`[src]

`type Target = GeometryInstance`

The resulting type after dereferencing.

`fn deref(&self) -> &GeometryInstance`[src]

`impl DerefMut for Particles`[src]

`fn deref_mut(&mut self) -> &mut GeometryInstance`[src]

`impl Free for Particles`[src]

`unsafe fn godot_free(self)`[src]

`impl FromVariant for Particles`[src]

`fn from_variant(variant: &Variant) -> Option<Self>`[src]

`impl GodotObject for Particles`[src]

`fn class_name() -> &'static str`[src]

`unsafe fn from_sys(obj: *mut godot_object) -> Self`[src]

`unsafe fn to_sys(&self) -> *mut godot_object`[src]

`impl Instanciable for Particles`[src]

`fn construct() -> Self`[src]

`impl QueueFree for Particles`[src]

`unsafe fn godot_queue_free(&mut self)`[src]

`impl ToVariant for Particles`[src]

`fn to_variant(&self) -> Variant`[src]

Auto Trait Implementations

`impl RefUnwindSafe for Particles`

`impl !Send for Particles`

`impl !Sync for Particles`

`impl Unpin for Particles`

`impl UnwindSafe for Particles`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]