Work in progress
Godot documentation is being updated to reflect the latest changes in version
4.0. Some documentation pages may
still state outdated information. This banner will tell you if you're reading one of such pages.
The contents of this page are up to date. If you can still find outdated information, please open an issue.
Inherits: ImageFormatLoader < RefCounted < Object
Base class for creating ImageFormatLoader extensions (adding support for extra image formats).
The engine supports multiple image formats out of the box (PNG, SVG, JPEG, WebP to name a few), but you can choose to implement support for additional image 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.
_get_recognized_extensions ( ) virtual const
_load_image ( Image image, FileAccess fileaccess, LoaderFlags flags, float scale ) virtual
PackedStringArray _get_recognized_extensions ( ) virtual const
Returns the list of file extensions for this image format. Files with the given extensions will be treated as image file and loaded using this class.
Error _load_image ( Image image, FileAccess fileaccess, LoaderFlags flags, float scale ) virtual
Loads the content of
fileaccess into the provided
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.