Struct gdnative_bindings_lily::AnimatedTexture

pub struct AnimatedTexture { /* fields omitted */ }

core class AnimatedTexture inherits Texture (reference counted).

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

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

Class hierarchy

AnimatedTexture inherits methods from:

• Texture
• 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 AnimatedTexture

Constants

pub const MAX_FRAMES: i64

impl AnimatedTexture

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 current_frame(&self) -> i64

Sets the currently visible frame of the texture.

pub fn fps(&self) -> f64

Animation speed in frames per second. This value defines the default time interval between two frames of the animation, and thus the overall duration of the animation loop based on the [member frames] property. A value of 0 means no predefined number of frames per second, the animation will play according to each frame’s frame delay (see [method set_frame_delay]). For example, an animation with 8 frames, no frame delay and a fps value of 2 will run for 4 seconds, with each frame lasting 0.5 seconds.

pub fn frame_delay(&self, frame: i64) -> f64

Returns the given frame’s delay value.

pub fn frame_texture(&self, frame: i64) -> Option<Ref<Texture, Shared>>

Returns the given frame’s Texture.

pub fn frames(&self) -> i64

Number of frames to use in the animation. While you can create the frames independently with [method set_frame_texture], you need to set this value for the animation to take new frames into account. The maximum number of frames is [constant MAX_FRAMES].

pub fn oneshot(&self) -> bool

If true, the animation will only play once and will not loop back to the first frame after reaching the end. Note that reaching the end will not set [member pause] to true.

pub fn pause(&self) -> bool

If true, the animation will pause where it currently is (i.e. at [member current_frame]). The animation will continue from where it was paused when changing this property to false.

pub fn set_current_frame(&self, frame: i64)

Sets the currently visible frame of the texture.

pub fn set_fps(&self, fps: f64)

Animation speed in frames per second. This value defines the default time interval between two frames of the animation, and thus the overall duration of the animation loop based on the [member frames] property. A value of 0 means no predefined number of frames per second, the animation will play according to each frame’s frame delay (see [method set_frame_delay]). For example, an animation with 8 frames, no frame delay and a fps value of 2 will run for 4 seconds, with each frame lasting 0.5 seconds.

pub fn set_frame_delay(&self, frame: i64, delay: f64)

Sample code is GDScript unless otherwise noted.

Sets an additional delay (in seconds) between this frame and the next one, that will be added to the time interval defined by [member fps]. By default, frames have no delay defined. If a delay value is defined, the final time interval between this frame and the next will be 1.0 / fps + delay. For example, for an animation with 3 frames, 2 FPS and a frame delay on the second frame of 1.2, the resulting playback will be:

Frame 0: 0.5 s (1 / fps)
Frame 1: 1.7 s (1 / fps + 1.2)
Frame 2: 0.5 s (1 / fps)
Total duration: 2.7 s

pub fn set_frame_texture(&self, frame: i64, texture: impl AsArg<Texture>)

Assigns a Texture to the given frame. Frame IDs start at 0, so the first frame has ID 0, and the last frame of the animation has ID [member frames] - 1. You can define any number of textures up to [constant MAX_FRAMES], but keep in mind that only frames from 0 to [member frames] - 1 will be part of the animation.

pub fn set_frames(&self, frames: i64)

Number of frames to use in the animation. While you can create the frames independently with [method set_frame_texture], you need to set this value for the animation to take new frames into account. The maximum number of frames is [constant MAX_FRAMES].

pub fn set_oneshot(&self, oneshot: bool)

If true, the animation will only play once and will not loop back to the first frame after reaching the end. Note that reaching the end will not set [member pause] to true.

pub fn set_pause(&self, pause: bool)

If true, the animation will pause where it currently is (i.e. at [member current_frame]). The animation will continue from where it was paused when changing this property to false.

Methods from Deref<Target = Texture>

pub const FLAGS_DEFAULT: i64

pub const FLAG_ANISOTROPIC_FILTER: i64

pub const FLAG_CONVERT_TO_LINEAR: i64

pub const FLAG_FILTER: i64

pub const FLAG_MIPMAPS: i64

pub const FLAG_MIRRORED_REPEAT: i64

pub const FLAG_REPEAT: i64

pub const FLAG_VIDEO_SURFACE: i64

pub fn draw(
    &self,
    canvas_item: Rid,
    position: Vector2,
    modulate: Color,
    transpose: bool,
    normal_map: impl AsArg<Texture>
)

Draws the texture using a CanvasItem with the VisualServer API at the specified position. Equivalent to [method VisualServer.canvas_item_add_texture_rect] with a rect at position and the size of this Texture.

Default Arguments

• modulate - Color( 1, 1, 1, 1 )
• transpose - false
• normal_map - null

pub fn draw_rect(
    &self,
    canvas_item: Rid,
    rect: Rect2,
    tile: bool,
    modulate: Color,
    transpose: bool,
    normal_map: impl AsArg<Texture>
)

Draws the texture using a CanvasItem with the VisualServer API. Equivalent to [method VisualServer.canvas_item_add_texture_rect].

Default Arguments

• modulate - Color( 1, 1, 1, 1 )
• transpose - false
• normal_map - null

pub fn draw_rect_region(
    &self,
    canvas_item: Rid,
    rect: Rect2,
    src_rect: Rect2,
    modulate: Color,
    transpose: bool,
    normal_map: impl AsArg<Texture>,
    clip_uv: bool
)

Draws a part of the texture using a CanvasItem with the VisualServer API. Equivalent to [method VisualServer.canvas_item_add_texture_rect_region].

Default Arguments

• modulate - Color( 1, 1, 1, 1 )
• transpose - false
• normal_map - null
• clip_uv - true

pub fn get_data(&self) -> Option<Ref<Image, Shared>>

Returns an Image that is a copy of data from this Texture. Images can be accessed and manipulated directly.

pub fn flags(&self) -> i64

The texture’s [enum Flags]. [enum Flags] are used to set various properties of the Texture.

pub fn get_height(&self) -> i64

Returns the texture height.

pub fn get_size(&self) -> Vector2

Returns the texture size.

pub fn get_width(&self) -> i64

Returns the texture width.

pub fn has_alpha(&self) -> bool

Returns true if this Texture has an alpha channel.

pub fn set_flags(&self, flags: i64)

The texture’s [enum Flags]. [enum Flags] are used to set various properties of the Texture.

Trait Implementations

impl Debug for AnimatedTexture

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

Formats the value using the given formatter.

impl Deref for AnimatedTexture

type Target = Texture

The resulting type after dereferencing.

fn deref(&self) -> &Texture

Dereferences the value.

impl DerefMut for AnimatedTexture

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

Mutably dereferences the value.

impl GodotObject for AnimatedTexture

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.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl Instanciable for AnimatedTexture

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

impl Sealed for AnimatedTexture

impl SubClass<Object> for AnimatedTexture

impl SubClass<Reference> for AnimatedTexture

impl SubClass<Resource> for AnimatedTexture

impl SubClass<Texture> for AnimatedTexture