[−][src]Struct gdnative::CPUParticles

pub struct CPUParticles { /* fields omitted */ }

core class CPUParticles 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.

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

Class hierarchy

CPUParticles inherits methods from:

Methods

`impl CPUParticles`[src]

Constants

`pub const PARAM_SCALE: i64`[src]

`pub const PARAM_INITIAL_LINEAR_VELOCITY: i64`[src]

`pub const DRAW_ORDER_VIEW_DEPTH: i64`[src]

`pub const PARAM_LINEAR_ACCEL: i64`[src]

`pub const PARAM_ORBIT_VELOCITY: i64`[src]

`pub const PARAM_TANGENTIAL_ACCEL: i64`[src]

`pub const DRAW_ORDER_INDEX: i64`[src]

`pub const PARAM_MAX: i64`[src]

`pub const FLAG_ALIGN_Y_TO_VELOCITY: i64`[src]

`pub const PARAM_DAMPING: i64`[src]

`pub const PARAM_ANGLE: i64`[src]

`pub const EMISSION_SHAPE_BOX: i64`[src]

`pub const EMISSION_SHAPE_POINT: i64`[src]

`pub const FLAG_ROTATE_Y: i64`[src]

`pub const EMISSION_SHAPE_POINTS: i64`[src]

`pub const EMISSION_SHAPE_DIRECTED_POINTS: i64`[src]

`pub const DRAW_ORDER_LIFETIME: i64`[src]

`pub const PARAM_ANGULAR_VELOCITY: i64`[src]

`pub const PARAM_ANIM_SPEED: i64`[src]

`pub const EMISSION_SHAPE_MAX: i64`[src]

`pub const FLAG_DISABLE_Z: i64`[src]

`pub const PARAM_RADIAL_ACCEL: i64`[src]

`pub const PARAM_ANIM_OFFSET: i64`[src]

`pub const PARAM_HUE_VARIATION: i64`[src]

`pub const FLAG_MAX: i64`[src]

`pub const EMISSION_SHAPE_SPHERE: i64`[src]

`impl CPUParticles`[src]

`pub fn new() -> CPUParticles`[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 CPUParticles::free.

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

Manually deallocate the object.

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

`pub unsafe fn convert_from_particles(&mut self, particles: Option<Node>)`[src]

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

`pub unsafe fn get_color(&self) -> Color`[src]

`pub unsafe fn get_color_ramp(&self) -> Option<Gradient>`[src]

`pub unsafe fn get_direction(&self) -> Vector3D<f32, UnknownUnit>`[src]

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

`pub unsafe fn get_emission_box_extents(&self) -> Vector3D<f32, UnknownUnit>`[src]

`pub unsafe fn get_emission_colors(&self) -> ColorArray`[src]

`pub unsafe fn get_emission_normals(&self) -> Vector3Array`[src]

`pub unsafe fn get_emission_points(&self) -> Vector3Array`[src]

`pub unsafe fn get_emission_shape(&self) -> CPUParticlesEmissionShape`[src]

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

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

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

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

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

`pub unsafe fn get_gravity(&self) -> Vector3D<f32, UnknownUnit>`[src]

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

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

`pub unsafe fn get_mesh(&self) -> Option<Mesh>`[src]

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

`pub unsafe fn get_param(&self, param: i64) -> f64`[src]

`pub unsafe fn get_param_curve(&self, param: i64) -> Option<Curve>`[src]

`pub unsafe fn get_param_randomness(&self, param: i64) -> f64`[src]

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

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

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

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

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

`pub unsafe fn get_use_local_coordinates(&self) -> bool`[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_color(&mut self, color: Color)`[src]

`pub unsafe fn set_color_ramp(&mut self, ramp: Option<Gradient>)`[src]

`pub unsafe fn set_direction(&mut self, direction: Vector3D<f32, UnknownUnit>)`[src]

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

`pub unsafe fn set_emission_box_extents( &mut self, extents: Vector3D<f32, UnknownUnit> )`[src]

`pub unsafe fn set_emission_colors(&mut self, array: ColorArray)`[src]

`pub unsafe fn set_emission_normals(&mut self, array: Vector3Array)`[src]

`pub unsafe fn set_emission_points(&mut self, array: Vector3Array)`[src]

`pub unsafe fn set_emission_shape(&mut self, shape: i64)`[src]

`pub unsafe fn set_emission_sphere_radius(&mut self, radius: f64)`[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_flatness(&mut self, amount: f64)`[src]

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

`pub unsafe fn set_gravity(&mut self, accel_vec: Vector3D<f32, UnknownUnit>)`[src]

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

`pub unsafe fn set_lifetime_randomness(&mut self, random: f64)`[src]

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

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

`pub unsafe fn set_param(&mut self, param: i64, value: f64)`[src]

`pub unsafe fn set_param_curve(&mut self, param: i64, curve: Option<Curve>)`[src]

`pub unsafe fn set_param_randomness(&mut self, param: i64, randomness: f64)`[src]

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

`pub unsafe fn set_pre_process_time(&mut self, secs: f64)`[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_spread(&mut self, degrees: f64)`[src]

`pub unsafe fn set_use_local_coordinates(&mut self, enable: bool)`[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>(&self) -> Option<T> where T: GodotObject,` [src]

Generic dynamic cast.

Methods from Deref<Target = GeometryInstance>

`pub const FLAG_MAX: i64`[src]

`pub const FLAG_DRAW_NEXT_FRAME_IF_VISIBLE: i64`[src]

`pub const SHADOW_CASTING_SETTING_OFF: i64`[src]

`pub const SHADOW_CASTING_SETTING_ON: i64`[src]

`pub const FLAG_USE_BAKED_LIGHT: i64`[src]

`pub const SHADOW_CASTING_SETTING_SHADOWS_ONLY: i64`[src]

`pub const SHADOW_CASTING_SETTING_DOUBLE_SIDED: 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_custom_aabb(&mut self, aabb: Aabb)`[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>(&self) -> Option<T> where T: GodotObject,` [src]

Generic dynamic cast.

Trait Implementations

`impl Clone for CPUParticles`[src]

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

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

`impl Copy for CPUParticles`[src]

`impl Debug for CPUParticles`[src]

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

`impl Deref for CPUParticles`[src]

`type Target = GeometryInstance`

The resulting type after dereferencing.

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

`impl DerefMut for CPUParticles`[src]

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

`impl Free for CPUParticles`[src]

`unsafe fn godot_free(self)`[src]

`impl FromVariant for CPUParticles`[src]

`fn from_variant(variant: &Variant) -> Result<CPUParticles, FromVariantError>`[src]

`impl GodotObject for CPUParticles`[src]

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

`unsafe fn from_sys(obj: *mut c_void) -> CPUParticles`[src]

`unsafe fn from_return_position_sys(obj: *mut c_void) -> CPUParticles`[src]

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

`impl Instanciable for CPUParticles`[src]

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

`impl QueueFree for CPUParticles`[src]

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

`impl ToVariant for CPUParticles`[src]

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

Auto Trait Implementations

`impl RefUnwindSafe for CPUParticles`

`impl !Send for CPUParticles`

`impl !Sync for CPUParticles`

`impl Unpin for CPUParticles`

`impl UnwindSafe for CPUParticles`

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> Export for T where T: GodotObject + ToVariant,` [src]

`type Hint = ()`

A type-specific hint type that is valid for the type being exported.

`fn export_info(_hint: Option<<T as Export>::Hint>) -> ExportInfo`[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]