Struct gdnative::Sprite3D

pub struct Sprite3D { /* fields omitted */ }

core class Sprite3D inherits SpriteBase3D (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.

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

Class hierarchy

Sprite3D inherits methods from:

• SpriteBase3D
• GeometryInstance
• VisualInstance
• Spatial
• Node
• Object

Methods

impl Sprite3D

pub fn new() -> Sprite3D

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

pub unsafe fn free(self)

Manually deallocate the object.

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_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_region(&self) -> 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_region(&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_sprite_base_3d(&self) -> SpriteBase3D

Up-cast.

pub unsafe fn to_geometry_instance(&self) -> GeometryInstance

Up-cast.

pub unsafe fn to_visual_instance(&self) -> VisualInstance

Up-cast.

pub unsafe fn to_spatial(&self) -> Spatial

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

pub const ALPHA_CUT_DISABLED: i64

pub const ALPHA_CUT_DISCARD: i64

pub const ALPHA_CUT_OPAQUE_PREPASS: i64

pub const FLAG_MAX: i64

pub const FLAG_SHADED: i64

pub const FLAG_TRANSPARENT: i64

pub const FLAG_DOUBLE_SIDED: i64

pub unsafe fn _im_update(&mut self)

pub unsafe fn _queue_update(&mut self)

pub unsafe fn generate_triangle_mesh(&self) -> Option<TriangleMesh>

pub unsafe fn get_alpha_cut_mode(&self) -> SpriteBase3DAlphaCutMode

pub unsafe fn get_axis(&self) -> Vector3Axis

pub unsafe fn get_billboard_mode(&self) -> SpatialMaterialBillboardMode

pub unsafe fn get_draw_flag(&self, flag: i64) -> bool

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

pub unsafe fn get_modulate(&self) -> Color

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

pub unsafe fn get_opacity(&self) -> f64

pub unsafe fn get_pixel_size(&self) -> f64

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 set_alpha_cut_mode(&mut self, mode: i64)

pub unsafe fn set_axis(&mut self, axis: i64)

pub unsafe fn set_billboard_mode(&mut self, mode: i64)

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

pub unsafe fn set_draw_flag(&mut self, flag: i64, enabled: 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_modulate(&mut self, modulate: Color)

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

pub unsafe fn set_opacity(&mut self, opacity: f64)

pub unsafe fn set_pixel_size(&mut self, pixel_size: f64)

pub unsafe fn to_geometry_instance(&self) -> GeometryInstance

Up-cast.

pub unsafe fn to_visual_instance(&self) -> VisualInstance

Up-cast.

pub unsafe fn to_spatial(&self) -> Spatial

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 Sprite3D

fn clone(&self) -> Sprite3D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Sprite3D

impl Debug for Sprite3D

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

Formats the value using the given formatter.

impl Deref for Sprite3D

type Target = SpriteBase3D

The resulting type after dereferencing.

fn deref(&self) -> &SpriteBase3D

Dereferences the value.

impl DerefMut for Sprite3D

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

Mutably dereferences the value.

impl Free for Sprite3D

unsafe fn godot_free(self)

impl FromVariant for Sprite3D

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

impl GodotObject for Sprite3D

fn class_name() -> &'static str

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

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

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

impl Instanciable for Sprite3D

fn construct() -> Sprite3D

impl QueueFree for Sprite3D

unsafe fn godot_queue_free(&mut self)

impl ToVariant for Sprite3D

fn to_variant(&self) -> Variant