[−][src]Struct gdnative_bindings::Sprite3D
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:
Methods
impl Sprite3D
[src]
pub fn new() -> Self
[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 Sprite3D::free
.
pub unsafe fn free(self)
[src]
Manually deallocate the object.
pub unsafe fn get_frame(&self) -> i64
[src]
pub unsafe fn get_hframes(&self) -> i64
[src]
pub unsafe fn get_region_rect(&self) -> Rect2
[src]
pub unsafe fn get_texture(&self) -> Option<Texture>
[src]
pub unsafe fn get_vframes(&self) -> i64
[src]
pub unsafe fn is_region(&self) -> bool
[src]
pub unsafe fn set_frame(&mut self, frame: i64)
[src]
pub unsafe fn set_hframes(&mut self, hframes: i64)
[src]
pub unsafe fn set_region(&mut self, enabled: bool)
[src]
pub unsafe fn set_region_rect(&mut self, rect: Rect2)
[src]
pub unsafe fn set_texture(&mut self, texture: Option<Texture>)
[src]
pub unsafe fn set_vframes(&mut self, vframes: i64)
[src]
pub unsafe fn to_sprite_base_3d(&self) -> SpriteBase3D
[src]
Up-cast.
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: GodotObject>(&self) -> Option<T>
[src]
Generic dynamic cast.
Methods from Deref<Target = SpriteBase3D>
pub const ALPHA_CUT_OPAQUE_PREPASS: i64
[src]
pub const FLAG_SHADED: i64
[src]
pub const FLAG_TRANSPARENT: i64
[src]
pub const FLAG_MAX: i64
[src]
pub const FLAG_DOUBLE_SIDED: i64
[src]
pub const ALPHA_CUT_DISCARD: i64
[src]
pub const ALPHA_CUT_DISABLED: i64
[src]
pub unsafe fn _im_update(&mut self)
[src]
pub unsafe fn _queue_update(&mut self)
[src]
pub unsafe fn generate_triangle_mesh(&self) -> Option<TriangleMesh>
[src]
pub unsafe fn get_alpha_cut_mode(&self) -> SpriteBase3DAlphaCutMode
[src]
pub unsafe fn get_axis(&self) -> Vector3Axis
[src]
pub unsafe fn get_draw_flag(&self, flag: i64) -> bool
[src]
pub unsafe fn get_item_rect(&self) -> Rect2
[src]
pub unsafe fn get_modulate(&self) -> Color
[src]
pub unsafe fn get_offset(&self) -> Vector2
[src]
pub unsafe fn get_opacity(&self) -> f64
[src]
pub unsafe fn get_pixel_size(&self) -> f64
[src]
pub unsafe fn is_centered(&self) -> bool
[src]
pub unsafe fn is_flipped_h(&self) -> bool
[src]
pub unsafe fn is_flipped_v(&self) -> bool
[src]
pub unsafe fn set_alpha_cut_mode(&mut self, mode: i64)
[src]
pub unsafe fn set_axis(&mut self, axis: i64)
[src]
pub unsafe fn set_centered(&mut self, centered: bool)
[src]
pub unsafe fn set_draw_flag(&mut self, flag: i64, enabled: bool)
[src]
pub unsafe fn set_flip_h(&mut self, flip_h: bool)
[src]
pub unsafe fn set_flip_v(&mut self, flip_v: bool)
[src]
pub unsafe fn set_modulate(&mut self, modulate: Color)
[src]
pub unsafe fn set_offset(&mut self, offset: Vector2)
[src]
pub unsafe fn set_opacity(&mut self, opacity: f64)
[src]
pub unsafe fn set_pixel_size(&mut self, pixel_size: f64)
[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: GodotObject>(&self) -> Option<T>
[src]
Generic dynamic cast.
Trait Implementations
impl Clone for Sprite3D
[src]
impl Copy for Sprite3D
[src]
impl Debug for Sprite3D
[src]
impl Deref for Sprite3D
[src]
type Target = SpriteBase3D
The resulting type after dereferencing.
fn deref(&self) -> &SpriteBase3D
[src]
impl DerefMut for Sprite3D
[src]
fn deref_mut(&mut self) -> &mut SpriteBase3D
[src]
impl Free for Sprite3D
[src]
unsafe fn godot_free(self)
[src]
impl FromVariant for Sprite3D
[src]
fn from_variant(variant: &Variant) -> Option<Self>
[src]
impl GodotObject for Sprite3D
[src]
fn class_name() -> &'static str
[src]
unsafe fn from_sys(obj: *mut godot_object) -> Self
[src]
unsafe fn to_sys(&self) -> *mut godot_object
[src]
impl Instanciable for Sprite3D
[src]
impl QueueFree for Sprite3D
[src]
unsafe fn godot_queue_free(&mut self)
[src]
impl ToVariant for Sprite3D
[src]
fn to_variant(&self) -> Variant
[src]
Auto Trait Implementations
impl RefUnwindSafe for Sprite3D
impl !Send for Sprite3D
impl !Sync for Sprite3D
impl Unpin for Sprite3D
impl UnwindSafe for Sprite3D
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
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]
U: Into<T>,
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]
U: TryFrom<T>,