animated_texture

This type is an animated texture. This texture type only supports animated GIF types, and does not support APNG.

This type inherits texture type. All of its base methods and fields are also available in this type.

__call

Constructs animated texture.

Arguments

1. From file.

Name

Type

Description

path

string

Path to the texture file.

2. From memory.

Name

Type

Description

data

Pointer to texture file data in memory.

sz

int

Size of the texture file data.

Returns

Type

Description

animated_texture

Animated texture instance.

Example

local gif = draw.animated_texture('funny_gif.gif');

should_loop

Type: bool

If set to false, will not loop the animation automatically. Defaults to true.


Reset loop to run from the first frame.

Arguments

None.

Returns

Nothing.

Example

gif:reset_loop();

set_frame

Set a specific frame on the animation. If looping is enabled, will continue the cycle from the passed frame. Otherwise, will display a specific frame of the animation.

Frame count starts from 0.

Arguments

Name

Type

Description

frame

int

Frame number. Invalid frame numbers will be clamped.

Returns

Nothing.

Example

gif:set_frame(5);

get_frame_count

Returns amount of frames in the animation.

Arguments

None.

Returns

Type

Description

int

Frame count.

Example

local frames = gif:get_frame_count();
gif:set_frame(frames - 2); -- set to the last frame

Last updated