Struct gdnative_bindings::SpriteFrames

pub struct SpriteFrames { /* fields omitted */ }

core class SpriteFrames inherits Resource (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

SpriteFrames inherits methods from:

• Resource
• Reference
• 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 SpriteFrames

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

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn add_animation(&self, anim: impl Into<GodotString>)

Adds a new animation to the library.

pub fn add_frame(
    &self,
    anim: impl Into<GodotString>,
    frame: impl AsArg<Texture>,
    at_position: i64
)

Adds a frame to the given animation.

Default Arguments

• at_position - -1

pub fn clear(&self, anim: impl Into<GodotString>)

Removes all frames from the given animation.

pub fn clear_all(&self)

Removes all animations. A "default" animation will be created.

pub fn get_animation_loop(&self, anim: impl Into<GodotString>) -> bool

If [code]true[/code], the given animation will loop.

pub fn get_animation_names(&self) -> StringArray

Returns an array containing the names associated to each animation. Values are placed in alphabetical order.

pub fn get_animation_speed(&self, anim: impl Into<GodotString>) -> f64

The animation's speed in frames per second.

pub fn get_frame(
    &self,
    anim: impl Into<GodotString>,
    idx: i64
) -> Option<Ref<Texture, Shared>>

Returns the animation's selected frame.

pub fn get_frame_count(&self, anim: impl Into<GodotString>) -> i64

Returns the number of frames in the animation.

pub fn has_animation(&self, anim: impl Into<GodotString>) -> bool

If [code]true[/code], the named animation exists.

pub fn remove_animation(&self, anim: impl Into<GodotString>)

Removes the given animation.

pub fn remove_frame(&self, anim: impl Into<GodotString>, idx: i64)

Removes the animation's selected frame.

pub fn rename_animation(
    &self,
    anim: impl Into<GodotString>,
    newname: impl Into<GodotString>
)

Changes the animation's name to [code]newname[/code].

pub fn set_animation_loop(&self, anim: impl Into<GodotString>, _loop: bool)

If [code]true[/code], the animation will loop.

pub fn set_animation_speed(&self, anim: impl Into<GodotString>, speed: f64)

The animation's speed in frames per second.

pub fn set_frame(
    &self,
    anim: impl Into<GodotString>,
    idx: i64,
    txt: impl AsArg<Texture>
)

Sets the texture of the given frame.

Methods from Deref<Target = Resource>

pub fn duplicate(&self, subresources: bool) -> Option<Ref<Resource, Shared>>

Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing [code]true[/code] to the [code]subresources[/code] argument which will copy the subresources.
				[b]Note:[/b] If [code]subresources[/code] is [code]true[/code], this method will only perform a shallow copy. Nested resources within subresources will not be duplicated and will still be shared.

Default Arguments

• subresources - false

pub fn get_local_scene(&self) -> Option<Ref<Node, Shared>>

If [member resource_local_to_scene] is enabled and the resource was loaded from a [PackedScene] instantiation, returns the local scene where this resource's unique copy is in use. Otherwise, returns [code]null[/code].

pub fn name(&self) -> GodotString

The name of the resource. This is an optional identifier.

pub fn path(&self) -> GodotString

The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index.

pub fn get_rid(&self) -> Rid

Returns the RID of the resource (or an empty RID). Many resources (such as [Texture], [Mesh], etc) are high-level abstractions of resources stored in a server, so this function will return the original RID.

pub fn is_local_to_scene(&self) -> bool

If [code]true[/code], the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.

pub fn set_local_to_scene(&self, enable: bool)

If [code]true[/code], the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.

pub fn set_name(&self, name: impl Into<GodotString>)

The name of the resource. This is an optional identifier.

pub fn set_path(&self, path: impl Into<GodotString>)

The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index.

pub fn setup_local_to_scene(&self)

This method is called when a resource with [member resource_local_to_scene] enabled is loaded from a [PackedScene] instantiation. Its behavior can be customized by overriding [method _setup_local_to_scene] from script.
				For most resources, this method performs no base logic. [ViewportTexture] performs custom logic to properly set the proxy texture and flags in the local viewport.

pub fn take_over_path(&self, path: impl Into<GodotString>)

Sets the path of the resource, potentially overriding an existing cache entry for this path. This differs from setting [member resource_path], as the latter would error out if another resource was already cached for the given path.

Trait Implementations

impl Debug for SpriteFrames

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

Formats the value using the given formatter.

impl Deref for SpriteFrames

type Target = Resource

The resulting type after dereferencing.

fn deref(&self) -> &Resource

Dereferences the value.

impl DerefMut for SpriteFrames

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

Mutably dereferences the value.

impl GodotObject for SpriteFrames

type RefKind = RefCounted

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 SpriteFrames

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

impl Sealed for SpriteFrames

impl SubClass<Object> for SpriteFrames

impl SubClass<Reference> for SpriteFrames

impl SubClass<Resource> for SpriteFrames