Attention: Here be dragons (unstable version)

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Redot.

ImageFramesFormatLoaderExtension

Inherits: ImageFramesFormatLoader < RefCounted < Object

Base class for creating ImageFramesFormatLoader extensions (adding support for extra image sequence formats).

Description

The engine supports multiple image sequence formats out of the box, but you can choose to implement support for additional image sequence formats by extending this class.

Be sure to respect the documented return types and values. You should create an instance of it, and call add_format_loader() to register that loader during the initialization phase.

Methods

PackedStringArray

_get_recognized_extensions() virtual const

Error

_load_image_frames(image_frames: ImageFrames, fileaccess: FileAccess, flags: BitField[LoaderFlags], scale: float, max_frames: int) virtual

void

add_format_loader()

void

remove_format_loader()


Method Descriptions

PackedStringArray _get_recognized_extensions() virtual const 🔗

There is currently no description for this method. Please help us by contributing one!


Error _load_image_frames(image_frames: ImageFrames, fileaccess: FileAccess, flags: BitField[LoaderFlags], scale: float, max_frames: int) virtual 🔗

Loads the content of fileaccess into the provided image_frames.


void add_format_loader() 🔗

Add this format loader to the engine, allowing it to recognize the file extensions returned by _get_recognized_extensions().


void remove_format_loader() 🔗

Remove this format loader from the engine.