Struct gdnative::api::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 a reference-only type. Persistent references can only exist in the unsafe Ref<Sprite3D> form.

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 Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

Sprite3D inherits methods from:

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

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl Sprite3D

pub fn new() -> Ref<Sprite3D, Unique>

Creates a new instance of this object.

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 Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn frame(&self) -> i64

Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1.

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

Coordinates of the frame to display from sprite sheet. This is as an alias for the [member frame] property. [member vframes] or [member hframes] must be greater than 1.

pub fn hframes(&self) -> i64

The number of columns in the sprite sheet.

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

The region of the atlas texture to display. [member region_enabled] must be [code]true[/code].

pub fn texture(&self) -> Option<Ref<Texture, Shared>>

[Texture] object to draw. If [member GeometryInstance.material_override] is used, this will be overridden.

pub fn vframes(&self) -> i64

The number of rows in the sprite sheet.

pub fn is_region(&self) -> bool

If [code]true[/code], texture will be cut from a larger atlas texture. See [member region_rect].

pub fn set_frame(&self, frame: i64)

Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1.

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

Coordinates of the frame to display from sprite sheet. This is as an alias for the [member frame] property. [member vframes] or [member hframes] must be greater than 1.

pub fn set_hframes(&self, hframes: i64)

The number of columns in the sprite sheet.

pub fn set_region(&self, enabled: bool)

If [code]true[/code], texture will be cut from a larger atlas texture. See [member region_rect].

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

The region of the atlas texture to display. [member region_enabled] must be [code]true[/code].

pub fn set_texture(&self, texture: impl AsArg<Texture>)

[Texture] object to draw. If [member GeometryInstance.material_override] is used, this will be overridden.

pub fn set_vframes(&self, vframes: i64)

The number of rows in the sprite sheet.

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_DOUBLE_SIDED: i64

pub const FLAG_MAX: i64

pub const FLAG_SHADED: i64

pub const FLAG_TRANSPARENT: i64

pub fn generate_triangle_mesh(&self) -> Option<Ref<TriangleMesh, Shared>>

pub fn alpha_cut_mode(&self) -> AlphaCutMode

pub fn axis(&self) -> Axis

The direction in which the front of the texture faces.

pub fn billboard_mode(&self) -> BillboardMode

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

If [code]true[/code], the texture's transparency and the opacity are used to make those parts of the sprite invisible.

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

Returns the rectangle representing this sprite.

pub fn modulate(&self) -> Color

A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light.

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

The texture's drawing offset.

pub fn opacity(&self) -> f64

The objects visibility on a scale from [code]0[/code] fully invisible to [code]1[/code] fully visible.

pub fn pixel_size(&self) -> f64

The size of one pixel's width on the sprite to scale it in 3D.

pub fn is_centered(&self) -> bool

If [code]true[/code], texture will be centered.

pub fn is_flipped_h(&self) -> bool

If [code]true[/code], texture is flipped horizontally.

pub fn is_flipped_v(&self) -> bool

If [code]true[/code], texture is flipped vertically.

pub fn set_alpha_cut_mode(&self, mode: i64)

pub fn set_axis(&self, axis: i64)

The direction in which the front of the texture faces.

pub fn set_billboard_mode(&self, mode: i64)

pub fn set_centered(&self, centered: bool)

If [code]true[/code], texture will be centered.

pub fn set_draw_flag(&self, flag: i64, enabled: bool)

If [code]true[/code], the texture's transparency and the opacity are used to make those parts of the sprite invisible.

pub fn set_flip_h(&self, flip_h: bool)

If [code]true[/code], texture is flipped horizontally.

pub fn set_flip_v(&self, flip_v: bool)

If [code]true[/code], texture is flipped vertically.

pub fn set_modulate(&self, modulate: Color)

A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light.

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

The texture's drawing offset.

pub fn set_opacity(&self, opacity: f64)

The objects visibility on a scale from [code]0[/code] fully invisible to [code]1[/code] fully visible.

pub fn set_pixel_size(&self, pixel_size: f64)

The size of one pixel's width on the sprite to scale it in 3D.

Trait Implementations

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 GodotObject for Sprite3D

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for Sprite3D

fn construct() -> Ref<Sprite3D, Unique>

impl QueueFree for Sprite3D

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<GeometryInstance> for Sprite3D

impl SubClass<Node> for Sprite3D

impl SubClass<Object> for Sprite3D

impl SubClass<Spatial> for Sprite3D

impl SubClass<SpriteBase3D> for Sprite3D

impl SubClass<VisualInstance> for Sprite3D