ImageFormatLoaderExtension
Base class for creating ImageFormatLoader extensions (adding support for extra image formats).
class ImageFormatLoaderExtensionThe 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 addFormatLoader to register that loader during the initialization phase.
Superclasses
class ImageFormatLoaderBase class to add support for specific image formats.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol Identifiable<ID>A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentableTypes that conform to VariantRepresentable can be stored directly in
Variantwith no conversion. These include all of the Variant types from Godot (for exampleGString,Rect,Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorableTypes that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Type members
Instance members
func addFormatLoader() Add this format loader to the engine, allowing it to recognize the file extensions returned by
_getRecognizedExtensions.func removeFormatLoader() Remove this format loader from the engine.
Show implementation details (2)
Hide implementation details
func _getRecognizedExtensions() -> PackedStringArray 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.
func _loadImage(Image?, fileaccess: FileAccess?, flags: ImageFormatLoader.LoaderFlags, scale: Double) -> GodotError Loads the content of
fileaccessinto the providedimage.