Struct gdnative::Particles2D

pub struct Particles2D { /* fields omitted */ }

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

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

Class hierarchy

Particles2D inherits methods from:

• Node2D
• CanvasItem
• Node
• Object

Methods

impl Particles2D

Constants

pub const DRAW_ORDER_INDEX: i64

pub const DRAW_ORDER_LIFETIME: i64

impl Particles2D

pub fn new() -> Particles2D

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn capture_rect(&self) -> Rect<f32, UnknownUnit>

pub unsafe fn get_amount(&self) -> i64

pub unsafe fn get_draw_order(&self) -> Particles2DDrawOrder

pub unsafe fn get_explosiveness_ratio(&self) -> f64

pub unsafe fn get_fixed_fps(&self) -> i64

pub unsafe fn get_fractional_delta(&self) -> bool

pub unsafe fn get_lifetime(&self) -> f64

pub unsafe fn get_normal_map(&self) -> Option<Texture>

pub unsafe fn get_one_shot(&self) -> bool

pub unsafe fn get_pre_process_time(&self) -> f64

pub unsafe fn get_process_material(&self) -> Option<Material>

pub unsafe fn get_randomness_ratio(&self) -> f64

pub unsafe fn get_speed_scale(&self) -> f64

pub unsafe fn get_texture(&self) -> Option<Texture>

pub unsafe fn get_use_local_coordinates(&self) -> bool

pub unsafe fn get_visibility_rect(&self) -> Rect<f32, UnknownUnit>

pub unsafe fn is_emitting(&self) -> bool

pub unsafe fn restart(&mut self)

pub unsafe fn set_amount(&mut self, amount: i64)

pub unsafe fn set_draw_order(&mut self, order: i64)

pub unsafe fn set_emitting(&mut self, emitting: bool)

pub unsafe fn set_explosiveness_ratio(&mut self, ratio: f64)

pub unsafe fn set_fixed_fps(&mut self, fps: i64)

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

pub unsafe fn set_lifetime(&mut self, secs: f64)

pub unsafe fn set_normal_map(&mut self, texture: Option<Texture>)

pub unsafe fn set_one_shot(&mut self, secs: bool)

pub unsafe fn set_pre_process_time(&mut self, secs: f64)

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

pub unsafe fn set_randomness_ratio(&mut self, ratio: f64)

pub unsafe fn set_speed_scale(&mut self, scale: f64)

pub unsafe fn set_texture(&mut self, texture: Option<Texture>)

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

pub unsafe fn set_visibility_rect(
    &mut self,
    visibility_rect: Rect<f32, UnknownUnit>
)

pub unsafe fn to_node_2d(&self) -> Node2D

Up-cast.

pub unsafe fn to_canvas_item(&self) -> CanvasItem

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 = Node2D>

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

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

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

pub unsafe fn get_global_rotation(&self) -> f64

pub unsafe fn get_global_rotation_degrees(&self) -> f64

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

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

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

pub unsafe fn get_rotation(&self) -> f64

pub unsafe fn get_rotation_degrees(&self) -> f64

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

pub unsafe fn get_z_index(&self) -> i64

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

pub unsafe fn is_z_relative(&self) -> bool

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

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

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

pub unsafe fn rotate(&mut self, radians: f64)

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

pub unsafe fn set_global_rotation(&mut self, radians: f64)

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

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

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

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

pub unsafe fn set_rotation(&mut self, radians: f64)

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

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

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

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

pub unsafe fn set_z_index(&mut self, z_index: i64)

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

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

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

pub unsafe fn to_canvas_item(&self) -> CanvasItem

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.

Trait Implementations

impl Clone for Particles2D

fn clone(&self) -> Particles2D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Particles2D

impl Debug for Particles2D

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

Formats the value using the given formatter.

impl Deref for Particles2D

type Target = Node2D

The resulting type after dereferencing.

fn deref(&self) -> &Node2D

Dereferences the value.

impl DerefMut for Particles2D

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

Mutably dereferences the value.

impl Free for Particles2D

unsafe fn godot_free(self)

impl FromVariant for Particles2D

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

impl GodotObject for Particles2D

fn class_name() -> &'static str

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

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

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

impl Instanciable for Particles2D

fn construct() -> Particles2D

impl QueueFree for Particles2D

unsafe fn godot_queue_free(&mut self)

impl ToVariant for Particles2D

fn to_variant(&self) -> Variant