Struct gdnative::Sprite

pub struct Sprite { /* fields omitted */ }

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

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

Class hierarchy

Sprite inherits methods from:

• Node2D
• CanvasItem
• Node
• Object

Methods

impl Sprite

pub fn new() -> Sprite

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 unsafe fn _texture_changed(&mut self)

pub unsafe fn get_frame(&self) -> i64

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

pub unsafe fn get_hframes(&self) -> i64

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

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

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

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

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

pub unsafe fn get_vframes(&self) -> i64

pub unsafe fn is_centered(&self) -> bool

pub unsafe fn is_flipped_h(&self) -> bool

pub unsafe fn is_flipped_v(&self) -> bool

pub unsafe fn is_pixel_opaque(&self, pos: Vector2D<f32, UnknownUnit>) -> bool

pub unsafe fn is_region(&self) -> bool

pub unsafe fn is_region_filter_clip_enabled(&self) -> bool

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

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

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

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

pub unsafe fn set_frame_coords(&mut self, coords: Vector2D<f32, UnknownUnit>)

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

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

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

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

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

pub unsafe fn set_region_rect(&mut self, rect: Rect<f32, UnknownUnit>)

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

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

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 Sprite

fn clone(&self) -> Sprite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Sprite

impl Debug for Sprite

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

Formats the value using the given formatter.

impl Deref for Sprite

type Target = Node2D

The resulting type after dereferencing.

fn deref(&self) -> &Node2D

Dereferences the value.

impl DerefMut for Sprite

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

Mutably dereferences the value.

impl Free for Sprite

unsafe fn godot_free(self)

impl FromVariant for Sprite

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

impl GodotObject for Sprite

fn class_name() -> &'static str

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

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

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

impl Instanciable for Sprite

fn construct() -> Sprite

impl QueueFree for Sprite

unsafe fn godot_queue_free(&mut self)

impl ToVariant for Sprite

fn to_variant(&self) -> Variant