class_imageformatloader.rst 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImageFormatLoader.xml.
  6. .. _class_ImageFormatLoader:
  7. ImageFormatLoader
  8. =================
  9. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`ImageFormatLoaderExtension<class_ImageFormatLoaderExtension>`
  11. Base class to add support for specific image formats.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. 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 :ref:`ImageFormatLoaderExtension<class_ImageFormatLoaderExtension>`.
  16. .. rst-class:: classref-section-separator
  17. ----
  18. .. rst-class:: classref-descriptions-group
  19. Enumerations
  20. ------------
  21. .. _enum_ImageFormatLoader_LoaderFlags:
  22. .. rst-class:: classref-enumeration
  23. flags **LoaderFlags**: :ref:`🔗<enum_ImageFormatLoader_LoaderFlags>`
  24. .. _class_ImageFormatLoader_constant_FLAG_NONE:
  25. .. rst-class:: classref-enumeration-constant
  26. :ref:`LoaderFlags<enum_ImageFormatLoader_LoaderFlags>` **FLAG_NONE** = ``0``
  27. .. container:: contribute
  28. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  29. .. _class_ImageFormatLoader_constant_FLAG_FORCE_LINEAR:
  30. .. rst-class:: classref-enumeration-constant
  31. :ref:`LoaderFlags<enum_ImageFormatLoader_LoaderFlags>` **FLAG_FORCE_LINEAR** = ``1``
  32. .. container:: contribute
  33. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  34. .. _class_ImageFormatLoader_constant_FLAG_CONVERT_COLORS:
  35. .. rst-class:: classref-enumeration-constant
  36. :ref:`LoaderFlags<enum_ImageFormatLoader_LoaderFlags>` **FLAG_CONVERT_COLORS** = ``2``
  37. .. container:: contribute
  38. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  39. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  40. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  41. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  42. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  43. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  44. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  45. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  46. .. |void| replace:: :abbr:`void (No return value.)`