Struct gdnative::Sprite

pub struct Sprite { /* fields omitted */ }

core class Sprite : Node2D (manually managed)

Base class

Sprite inherits Node2D and all of its methods.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine. In the cases where Rust code owns an object of this type, ownership should be either passed to the engine or the object must be manually destroyed using Sprite::free.

Methods

impl Sprite

pub fn as_node_2d(&self) -> Node2D

Up-cast.

pub fn new() -> Self

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

pub unsafe fn free(self)

Manually deallocate the object.

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

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

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

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

pub fn set_centered(&mut self, centered: bool)

pub fn is_centered(&self) -> bool

pub fn set_offset(&mut self, offset: Vector2)

pub fn get_offset(&self) -> Vector2

pub fn set_flip_h(&mut self, flip_h: bool)

pub fn is_flipped_h(&self) -> bool

pub fn set_flip_v(&mut self, flip_v: bool)

pub fn is_flipped_v(&self) -> bool

pub fn set_region(&mut self, enabled: bool)

pub fn is_region(&self) -> bool

pub fn set_region_rect(&mut self, rect: Rect2)

pub fn get_region_rect(&self) -> Rect2

pub fn set_region_filter_clip(&mut self, enabled: bool)

pub fn is_region_filter_clip_enabled(&self) -> bool

pub fn set_frame(&mut self, frame: i64)

pub fn get_frame(&self) -> i64

pub fn set_vframes(&mut self, vframes: i64)

pub fn get_vframes(&self) -> i64

pub fn set_hframes(&mut self, hframes: i64)

pub fn get_hframes(&self) -> i64

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

Methods from Deref<Target = Node2D>

pub fn as_canvas_item(&self) -> CanvasItem

Up-cast.

pub fn set_position(&mut self, position: Vector2)

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

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

pub fn set_scale(&mut self, scale: Vector2)

pub fn get_position(&self) -> Vector2

pub fn get_rotation(&self) -> f64

pub fn get_rotation_degrees(&self) -> f64

pub fn get_scale(&self) -> Vector2

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

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

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

pub fn translate(&mut self, offset: Vector2)

pub fn global_translate(&mut self, offset: Vector2)

pub fn apply_scale(&mut self, ratio: Vector2)

pub fn set_global_position(&mut self, position: Vector2)

pub fn get_global_position(&self) -> Vector2

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

pub fn get_global_rotation(&self) -> f64

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

pub fn get_global_rotation_degrees(&self) -> f64

pub fn set_global_scale(&mut self, scale: Vector2)

pub fn get_global_scale(&self) -> Vector2

pub fn set_transform(&mut self, xform: Transform2D)

pub fn set_global_transform(&mut self, xform: Transform2D)

pub fn look_at(&mut self, point: Vector2)

pub fn get_angle_to(&self, point: Vector2) -> f64

pub fn to_local(&self, global_point: Vector2) -> Vector2

pub fn to_global(&self, local_point: Vector2) -> Vector2

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

pub fn get_z_index(&self) -> i64

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

pub fn is_z_relative(&self) -> bool

pub fn get_relative_transform_to_parent(
    &self,
    parent: Option<Object>
) -> Transform2D

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

Trait Implementations

impl GodotObject for Sprite

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

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

impl Deref for Sprite

type Target = Node2D

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Sprite

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.