godot-docs/classes/class_image.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Image.xml.

.. _class_Image:

Image
=====

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

Image datatype.

.. rst-class:: classref-introduction-group

Description
-----------

Native image datatype. Contains image data which can be converted to an :ref:`ImageTexture<class_ImageTexture>` and provides commonly used *image processing* methods. The maximum width and height for an **Image** are :ref:`MAX_WIDTH<class_Image_constant_MAX_WIDTH>` and :ref:`MAX_HEIGHT<class_Image_constant_MAX_HEIGHT>`.

An **Image** cannot be assigned to a texture property of an object directly (such as :ref:`Sprite2D.texture<class_Sprite2D_property_texture>`), and has to be converted manually to an :ref:`ImageTexture<class_ImageTexture>` first.

\ **Note:** The maximum image size is 16384×16384 pixels due to graphics hardware limitations. Larger images may fail to import.

.. rst-class:: classref-introduction-group

Tutorials
---------

- :doc:`Importing images <../tutorials/assets_pipeline/importing_images>`

- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>`

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +-------------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------+
   | :ref:`Dictionary<class_Dictionary>` | :ref:`data<class_Image_property_data>` | ``{ "data": PackedByteArray(), "format": "Lum8", "height": 0, "mipmaps": false, "width": 0 }`` |
   +-------------------------------------+----------------------------------------+------------------------------------------------------------------------------------------------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`adjust_bcs<class_Image_method_adjust_bcs>`\ (\ brightness\: :ref:`float<class_float>`, contrast\: :ref:`float<class_float>`, saturation\: :ref:`float<class_float>`\ )                                                                                                       |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`blend_rect<class_Image_method_blend_rect>`\ (\ src\: :ref:`Image<class_Image>`, src_rect\: :ref:`Rect2i<class_Rect2i>`, dst\: :ref:`Vector2i<class_Vector2i>`\ )                                                                                                             |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`blend_rect_mask<class_Image_method_blend_rect_mask>`\ (\ src\: :ref:`Image<class_Image>`, mask\: :ref:`Image<class_Image>`, src_rect\: :ref:`Rect2i<class_Rect2i>`, dst\: :ref:`Vector2i<class_Vector2i>`\ )                                                                 |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`blit_rect<class_Image_method_blit_rect>`\ (\ src\: :ref:`Image<class_Image>`, src_rect\: :ref:`Rect2i<class_Rect2i>`, dst\: :ref:`Vector2i<class_Vector2i>`\ )                                                                                                               |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`blit_rect_mask<class_Image_method_blit_rect_mask>`\ (\ src\: :ref:`Image<class_Image>`, mask\: :ref:`Image<class_Image>`, src_rect\: :ref:`Rect2i<class_Rect2i>`, dst\: :ref:`Vector2i<class_Vector2i>`\ )                                                                   |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`bump_map_to_normal_map<class_Image_method_bump_map_to_normal_map>`\ (\ bump_scale\: :ref:`float<class_float>` = 1.0\ )                                                                                                                                                       |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`clear_mipmaps<class_Image_method_clear_mipmaps>`\ (\ )                                                                                                                                                                                                                       |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`compress<class_Image_method_compress>`\ (\ mode\: :ref:`CompressMode<enum_Image_CompressMode>`, source\: :ref:`CompressSource<enum_Image_CompressSource>` = 0, astc_format\: :ref:`ASTCFormat<enum_Image_ASTCFormat>` = 0\ )                                                 |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`compress_from_channels<class_Image_method_compress_from_channels>`\ (\ mode\: :ref:`CompressMode<enum_Image_CompressMode>`, channels\: :ref:`UsedChannels<enum_Image_UsedChannels>`, astc_format\: :ref:`ASTCFormat<enum_Image_ASTCFormat>` = 0\ )                           |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Dictionary<class_Dictionary>`           | :ref:`compute_image_metrics<class_Image_method_compute_image_metrics>`\ (\ compared_image\: :ref:`Image<class_Image>`, use_luma\: :ref:`bool<class_bool>`\ )                                                                                                                       |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`convert<class_Image_method_convert>`\ (\ format\: :ref:`Format<enum_Image_Format>`\ )                                                                                                                                                                                        |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`copy_from<class_Image_method_copy_from>`\ (\ src\: :ref:`Image<class_Image>`\ )                                                                                                                                                                                              |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Image<class_Image>`                     | :ref:`create<class_Image_method_create>`\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, use_mipmaps\: :ref:`bool<class_bool>`, format\: :ref:`Format<enum_Image_Format>`\ ) |static|                                                                           |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Image<class_Image>`                     | :ref:`create_empty<class_Image_method_create_empty>`\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, use_mipmaps\: :ref:`bool<class_bool>`, format\: :ref:`Format<enum_Image_Format>`\ ) |static|                                                               |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Image<class_Image>`                     | :ref:`create_from_data<class_Image_method_create_from_data>`\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, use_mipmaps\: :ref:`bool<class_bool>`, format\: :ref:`Format<enum_Image_Format>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |static| |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`crop<class_Image_method_crop>`\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`\ )                                                                                                                                                                          |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`decompress<class_Image_method_decompress>`\ (\ )                                                                                                                                                                                                                             |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`AlphaMode<enum_Image_AlphaMode>`        | :ref:`detect_alpha<class_Image_method_detect_alpha>`\ (\ ) |const|                                                                                                                                                                                                                 |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`UsedChannels<enum_Image_UsedChannels>`  | :ref:`detect_used_channels<class_Image_method_detect_used_channels>`\ (\ source\: :ref:`CompressSource<enum_Image_CompressSource>` = 0\ ) |const|                                                                                                                                  |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`fill<class_Image_method_fill>`\ (\ color\: :ref:`Color<class_Color>`\ )                                                                                                                                                                                                      |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`fill_rect<class_Image_method_fill_rect>`\ (\ rect\: :ref:`Rect2i<class_Rect2i>`, color\: :ref:`Color<class_Color>`\ )                                                                                                                                                        |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`fix_alpha_edges<class_Image_method_fix_alpha_edges>`\ (\ )                                                                                                                                                                                                                   |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`flip_x<class_Image_method_flip_x>`\ (\ )                                                                                                                                                                                                                                     |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`flip_y<class_Image_method_flip_y>`\ (\ )                                                                                                                                                                                                                                     |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`generate_mipmaps<class_Image_method_generate_mipmaps>`\ (\ renormalize\: :ref:`bool<class_bool>` = false\ )                                                                                                                                                                  |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`get_data<class_Image_method_get_data>`\ (\ ) |const|                                                                                                                                                                                                                         |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_data_size<class_Image_method_get_data_size>`\ (\ ) |const|                                                                                                                                                                                                               |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Format<enum_Image_Format>`              | :ref:`get_format<class_Image_method_get_format>`\ (\ ) |const|                                                                                                                                                                                                                     |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_height<class_Image_method_get_height>`\ (\ ) |const|                                                                                                                                                                                                                     |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_mipmap_count<class_Image_method_get_mipmap_count>`\ (\ ) |const|                                                                                                                                                                                                         |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_mipmap_offset<class_Image_method_get_mipmap_offset>`\ (\ mipmap\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                       |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`                     | :ref:`get_pixel<class_Image_method_get_pixel>`\ (\ x\: :ref:`int<class_int>`, y\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                 |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`                     | :ref:`get_pixelv<class_Image_method_get_pixelv>`\ (\ point\: :ref:`Vector2i<class_Vector2i>`\ ) |const|                                                                                                                                                                            |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Image<class_Image>`                     | :ref:`get_region<class_Image_method_get_region>`\ (\ region\: :ref:`Rect2i<class_Rect2i>`\ ) |const|                                                                                                                                                                               |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2i<class_Vector2i>`               | :ref:`get_size<class_Image_method_get_size>`\ (\ ) |const|                                                                                                                                                                                                                         |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Rect2i<class_Rect2i>`                   | :ref:`get_used_rect<class_Image_method_get_used_rect>`\ (\ ) |const|                                                                                                                                                                                                               |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_width<class_Image_method_get_width>`\ (\ ) |const|                                                                                                                                                                                                                       |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`has_mipmaps<class_Image_method_has_mipmaps>`\ (\ ) |const|                                                                                                                                                                                                                   |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`is_compressed<class_Image_method_is_compressed>`\ (\ ) |const|                                                                                                                                                                                                               |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`is_empty<class_Image_method_is_empty>`\ (\ ) |const|                                                                                                                                                                                                                         |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`is_invisible<class_Image_method_is_invisible>`\ (\ ) |const|                                                                                                                                                                                                                 |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`linear_to_srgb<class_Image_method_linear_to_srgb>`\ (\ )                                                                                                                                                                                                                     |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`load<class_Image_method_load>`\ (\ path\: :ref:`String<class_String>`\ )                                                                                                                                                                                                     |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`load_bmp_from_buffer<class_Image_method_load_bmp_from_buffer>`\ (\ buffer\: :ref:`PackedByteArray<class_PackedByteArray>`\ )                                                                                                                                                 |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Image<class_Image>`                     | :ref:`load_from_file<class_Image_method_load_from_file>`\ (\ path\: :ref:`String<class_String>`\ ) |static|                                                                                                                                                                        |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`load_jpg_from_buffer<class_Image_method_load_jpg_from_buffer>`\ (\ buffer\: :ref:`PackedByteArray<class_PackedByteArray>`\ )                                                                                                                                                 |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`load_ktx_from_buffer<class_Image_method_load_ktx_from_buffer>`\ (\ buffer\: :ref:`PackedByteArray<class_PackedByteArray>`\ )                                                                                                                                                 |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`load_png_from_buffer<class_Image_method_load_png_from_buffer>`\ (\ buffer\: :ref:`PackedByteArray<class_PackedByteArray>`\ )                                                                                                                                                 |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`load_svg_from_buffer<class_Image_method_load_svg_from_buffer>`\ (\ buffer\: :ref:`PackedByteArray<class_PackedByteArray>`, scale\: :ref:`float<class_float>` = 1.0\ )                                                                                                        |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`load_svg_from_string<class_Image_method_load_svg_from_string>`\ (\ svg_str\: :ref:`String<class_String>`, scale\: :ref:`float<class_float>` = 1.0\ )                                                                                                                         |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`load_tga_from_buffer<class_Image_method_load_tga_from_buffer>`\ (\ buffer\: :ref:`PackedByteArray<class_PackedByteArray>`\ )                                                                                                                                                 |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`load_webp_from_buffer<class_Image_method_load_webp_from_buffer>`\ (\ buffer\: :ref:`PackedByteArray<class_PackedByteArray>`\ )                                                                                                                                               |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`normal_map_to_xy<class_Image_method_normal_map_to_xy>`\ (\ )                                                                                                                                                                                                                 |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`premultiply_alpha<class_Image_method_premultiply_alpha>`\ (\ )                                                                                                                                                                                                               |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`resize<class_Image_method_resize>`\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, interpolation\: :ref:`Interpolation<enum_Image_Interpolation>` = 1\ )                                                                                                  |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`resize_to_po2<class_Image_method_resize_to_po2>`\ (\ square\: :ref:`bool<class_bool>` = false, interpolation\: :ref:`Interpolation<enum_Image_Interpolation>` = 1\ )                                                                                                         |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Image<class_Image>`                     | :ref:`rgbe_to_srgb<class_Image_method_rgbe_to_srgb>`\ (\ )                                                                                                                                                                                                                         |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`rotate_90<class_Image_method_rotate_90>`\ (\ direction\: :ref:`ClockDirection<enum_@GlobalScope_ClockDirection>`\ )                                                                                                                                                          |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`rotate_180<class_Image_method_rotate_180>`\ (\ )                                                                                                                                                                                                                             |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`save_exr<class_Image_method_save_exr>`\ (\ path\: :ref:`String<class_String>`, grayscale\: :ref:`bool<class_bool>` = false\ ) |const|                                                                                                                                        |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`save_exr_to_buffer<class_Image_method_save_exr_to_buffer>`\ (\ grayscale\: :ref:`bool<class_bool>` = false\ ) |const|                                                                                                                                                        |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`save_jpg<class_Image_method_save_jpg>`\ (\ path\: :ref:`String<class_String>`, quality\: :ref:`float<class_float>` = 0.75\ ) |const|                                                                                                                                         |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`save_jpg_to_buffer<class_Image_method_save_jpg_to_buffer>`\ (\ quality\: :ref:`float<class_float>` = 0.75\ ) |const|                                                                                                                                                         |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`save_png<class_Image_method_save_png>`\ (\ path\: :ref:`String<class_String>`\ ) |const|                                                                                                                                                                                     |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`save_png_to_buffer<class_Image_method_save_png_to_buffer>`\ (\ ) |const|                                                                                                                                                                                                     |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`save_webp<class_Image_method_save_webp>`\ (\ path\: :ref:`String<class_String>`, lossy\: :ref:`bool<class_bool>` = false, quality\: :ref:`float<class_float>` = 0.75\ ) |const|                                                                                              |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`save_webp_to_buffer<class_Image_method_save_webp_to_buffer>`\ (\ lossy\: :ref:`bool<class_bool>` = false, quality\: :ref:`float<class_float>` = 0.75\ ) |const|                                                                                                              |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`set_data<class_Image_method_set_data>`\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, use_mipmaps\: :ref:`bool<class_bool>`, format\: :ref:`Format<enum_Image_Format>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ )                          |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`set_pixel<class_Image_method_set_pixel>`\ (\ x\: :ref:`int<class_int>`, y\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`\ )                                                                                                                                      |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`set_pixelv<class_Image_method_set_pixelv>`\ (\ point\: :ref:`Vector2i<class_Vector2i>`, color\: :ref:`Color<class_Color>`\ )                                                                                                                                                 |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`shrink_x2<class_Image_method_shrink_x2>`\ (\ )                                                                                                                                                                                                                               |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                        | :ref:`srgb_to_linear<class_Image_method_srgb_to_linear>`\ (\ )                                                                                                                                                                                                                     |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Enumerations
------------

.. _enum_Image_Format:

.. rst-class:: classref-enumeration

enum **Format**: :ref:`🔗<enum_Image_Format>`

.. _class_Image_constant_FORMAT_L8:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_L8** = ``0``

Texture format with a single 8-bit depth representing luminance.

.. _class_Image_constant_FORMAT_LA8:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_LA8** = ``1``

OpenGL texture format with two values, luminance and alpha each stored with 8 bits.

.. _class_Image_constant_FORMAT_R8:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_R8** = ``2``

OpenGL texture format ``RED`` with a single component and a bitdepth of 8.

.. _class_Image_constant_FORMAT_RG8:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RG8** = ``3``

OpenGL texture format ``RG`` with two components and a bitdepth of 8 for each.

.. _class_Image_constant_FORMAT_RGB8:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RGB8** = ``4``

OpenGL texture format ``RGB`` with three components, each with a bitdepth of 8.

\ **Note:** When creating an :ref:`ImageTexture<class_ImageTexture>`, an sRGB to linear color space conversion is performed.

.. _class_Image_constant_FORMAT_RGBA8:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RGBA8** = ``5``

OpenGL texture format ``RGBA`` with four components, each with a bitdepth of 8.

\ **Note:** When creating an :ref:`ImageTexture<class_ImageTexture>`, an sRGB to linear color space conversion is performed.

.. _class_Image_constant_FORMAT_RGBA4444:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RGBA4444** = ``6``

OpenGL texture format ``RGBA`` with four components, each with a bitdepth of 4.

.. _class_Image_constant_FORMAT_RGB565:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RGB565** = ``7``

OpenGL texture format ``RGB`` with three components. Red and blue have a bitdepth of 5, and green has a bitdepth of 6.

.. _class_Image_constant_FORMAT_RF:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RF** = ``8``

OpenGL texture format ``GL_R32F`` where there's one component, a 32-bit floating-point value.

.. _class_Image_constant_FORMAT_RGF:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RGF** = ``9``

OpenGL texture format ``GL_RG32F`` where there are two components, each a 32-bit floating-point values.

.. _class_Image_constant_FORMAT_RGBF:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RGBF** = ``10``

OpenGL texture format ``GL_RGB32F`` where there are three components, each a 32-bit floating-point values.

.. _class_Image_constant_FORMAT_RGBAF:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RGBAF** = ``11``

OpenGL texture format ``GL_RGBA32F`` where there are four components, each a 32-bit floating-point values.

.. _class_Image_constant_FORMAT_RH:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RH** = ``12``

OpenGL texture format ``GL_R16F`` where there's one component, a 16-bit "half-precision" floating-point value.

.. _class_Image_constant_FORMAT_RGH:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RGH** = ``13``

OpenGL texture format ``GL_RG16F`` where there are two components, each a 16-bit "half-precision" floating-point value.

.. _class_Image_constant_FORMAT_RGBH:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RGBH** = ``14``

OpenGL texture format ``GL_RGB16F`` where there are three components, each a 16-bit "half-precision" floating-point value.

.. _class_Image_constant_FORMAT_RGBAH:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RGBAH** = ``15``

OpenGL texture format ``GL_RGBA16F`` where there are four components, each a 16-bit "half-precision" floating-point value.

.. _class_Image_constant_FORMAT_RGBE9995:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RGBE9995** = ``16``

A special OpenGL texture format where the three color components have 9 bits of precision and all three share a single 5-bit exponent.

.. _class_Image_constant_FORMAT_DXT1:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_DXT1** = ``17``

The `S3TC <https://en.wikipedia.org/wiki/S3_Texture_Compression>`__ texture format that uses Block Compression 1, and is the smallest variation of S3TC, only providing 1 bit of alpha and color data being premultiplied with alpha.

\ **Note:** When creating an :ref:`ImageTexture<class_ImageTexture>`, an sRGB to linear color space conversion is performed.

.. _class_Image_constant_FORMAT_DXT3:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_DXT3** = ``18``

The `S3TC <https://en.wikipedia.org/wiki/S3_Texture_Compression>`__ texture format that uses Block Compression 2, and color data is interpreted as not having been premultiplied by alpha. Well suited for images with sharp alpha transitions between translucent and opaque areas.

\ **Note:** When creating an :ref:`ImageTexture<class_ImageTexture>`, an sRGB to linear color space conversion is performed.

.. _class_Image_constant_FORMAT_DXT5:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_DXT5** = ``19``

The `S3TC <https://en.wikipedia.org/wiki/S3_Texture_Compression>`__ texture format also known as Block Compression 3 or BC3 that contains 64 bits of alpha channel data followed by 64 bits of DXT1-encoded color data. Color data is not premultiplied by alpha, same as DXT3. DXT5 generally produces superior results for transparent gradients compared to DXT3.

\ **Note:** When creating an :ref:`ImageTexture<class_ImageTexture>`, an sRGB to linear color space conversion is performed.

.. _class_Image_constant_FORMAT_RGTC_R:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RGTC_R** = ``20``

Texture format that uses `Red Green Texture Compression <https://www.khronos.org/opengl/wiki/Red_Green_Texture_Compression>`__, normalizing the red channel data using the same compression algorithm that DXT5 uses for the alpha channel.

.. _class_Image_constant_FORMAT_RGTC_RG:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_RGTC_RG** = ``21``

Texture format that uses `Red Green Texture Compression <https://www.khronos.org/opengl/wiki/Red_Green_Texture_Compression>`__, normalizing the red and green channel data using the same compression algorithm that DXT5 uses for the alpha channel.

.. _class_Image_constant_FORMAT_BPTC_RGBA:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_BPTC_RGBA** = ``22``

Texture format that uses `BPTC <https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression>`__ compression with unsigned normalized RGBA components.

\ **Note:** When creating an :ref:`ImageTexture<class_ImageTexture>`, an sRGB to linear color space conversion is performed.

.. _class_Image_constant_FORMAT_BPTC_RGBF:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_BPTC_RGBF** = ``23``

Texture format that uses `BPTC <https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression>`__ compression with signed floating-point RGB components.

.. _class_Image_constant_FORMAT_BPTC_RGBFU:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_BPTC_RGBFU** = ``24``

Texture format that uses `BPTC <https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression>`__ compression with unsigned floating-point RGB components.

.. _class_Image_constant_FORMAT_ETC:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_ETC** = ``25``

`Ericsson Texture Compression format 1 <https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC1>`__, also referred to as "ETC1", and is part of the OpenGL ES graphics standard. This format cannot store an alpha channel.

.. _class_Image_constant_FORMAT_ETC2_R11:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_ETC2_R11** = ``26``

`Ericsson Texture Compression format 2 <https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC>`__ (``R11_EAC`` variant), which provides one channel of unsigned data.

.. _class_Image_constant_FORMAT_ETC2_R11S:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_ETC2_R11S** = ``27``

`Ericsson Texture Compression format 2 <https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC>`__ (``SIGNED_R11_EAC`` variant), which provides one channel of signed data.

.. _class_Image_constant_FORMAT_ETC2_RG11:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_ETC2_RG11** = ``28``

`Ericsson Texture Compression format 2 <https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC>`__ (``RG11_EAC`` variant), which provides two channels of unsigned data.

.. _class_Image_constant_FORMAT_ETC2_RG11S:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_ETC2_RG11S** = ``29``

`Ericsson Texture Compression format 2 <https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC>`__ (``SIGNED_RG11_EAC`` variant), which provides two channels of signed data.

.. _class_Image_constant_FORMAT_ETC2_RGB8:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_ETC2_RGB8** = ``30``

`Ericsson Texture Compression format 2 <https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC>`__ (``RGB8`` variant), which is a follow-up of ETC1 and compresses RGB888 data.

\ **Note:** When creating an :ref:`ImageTexture<class_ImageTexture>`, an sRGB to linear color space conversion is performed.

.. _class_Image_constant_FORMAT_ETC2_RGBA8:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_ETC2_RGBA8** = ``31``

`Ericsson Texture Compression format 2 <https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC>`__ (``RGBA8``\ variant), which compresses RGBA8888 data with full alpha support.

\ **Note:** When creating an :ref:`ImageTexture<class_ImageTexture>`, an sRGB to linear color space conversion is performed.

.. _class_Image_constant_FORMAT_ETC2_RGB8A1:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_ETC2_RGB8A1** = ``32``

`Ericsson Texture Compression format 2 <https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC>`__ (``RGB8_PUNCHTHROUGH_ALPHA1`` variant), which compresses RGBA data to make alpha either fully transparent or fully opaque.

\ **Note:** When creating an :ref:`ImageTexture<class_ImageTexture>`, an sRGB to linear color space conversion is performed.

.. _class_Image_constant_FORMAT_ETC2_RA_AS_RG:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_ETC2_RA_AS_RG** = ``33``

`Ericsson Texture Compression format 2 <https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC>`__ (``RGBA8`` variant), which compresses RA data and interprets it as two channels (red and green). See also :ref:`FORMAT_ETC2_RGBA8<class_Image_constant_FORMAT_ETC2_RGBA8>`.

.. _class_Image_constant_FORMAT_DXT5_RA_AS_RG:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_DXT5_RA_AS_RG** = ``34``

The `S3TC <https://en.wikipedia.org/wiki/S3_Texture_Compression>`__ texture format also known as Block Compression 3 or BC3, which compresses RA data and interprets it as two channels (red and green). See also :ref:`FORMAT_DXT5<class_Image_constant_FORMAT_DXT5>`.

.. _class_Image_constant_FORMAT_ASTC_4x4:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_ASTC_4x4** = ``35``

`Adaptive Scalable Texture Compression <https://en.wikipedia.org/wiki/Adaptive_scalable_texture_compression>`__. This implements the 4×4 (high quality) mode.

.. _class_Image_constant_FORMAT_ASTC_4x4_HDR:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_ASTC_4x4_HDR** = ``36``

Same format as :ref:`FORMAT_ASTC_4x4<class_Image_constant_FORMAT_ASTC_4x4>`, but with the hint to let the GPU know it is used for HDR.

.. _class_Image_constant_FORMAT_ASTC_8x8:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_ASTC_8x8** = ``37``

`Adaptive Scalable Texture Compression <https://en.wikipedia.org/wiki/Adaptive_scalable_texture_compression>`__. This implements the 8×8 (low quality) mode.

.. _class_Image_constant_FORMAT_ASTC_8x8_HDR:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_ASTC_8x8_HDR** = ``38``

Same format as :ref:`FORMAT_ASTC_8x8<class_Image_constant_FORMAT_ASTC_8x8>`, but with the hint to let the GPU know it is used for HDR.

.. _class_Image_constant_FORMAT_MAX:

.. rst-class:: classref-enumeration-constant

:ref:`Format<enum_Image_Format>` **FORMAT_MAX** = ``39``

Represents the size of the :ref:`Format<enum_Image_Format>` enum.

.. rst-class:: classref-item-separator

----

.. _enum_Image_Interpolation:

.. rst-class:: classref-enumeration

enum **Interpolation**: :ref:`🔗<enum_Image_Interpolation>`

.. _class_Image_constant_INTERPOLATE_NEAREST:

.. rst-class:: classref-enumeration-constant

:ref:`Interpolation<enum_Image_Interpolation>` **INTERPOLATE_NEAREST** = ``0``

Performs nearest-neighbor interpolation. If the image is resized, it will be pixelated.

.. _class_Image_constant_INTERPOLATE_BILINEAR:

.. rst-class:: classref-enumeration-constant

:ref:`Interpolation<enum_Image_Interpolation>` **INTERPOLATE_BILINEAR** = ``1``

Performs bilinear interpolation. If the image is resized, it will be blurry. This mode is faster than :ref:`INTERPOLATE_CUBIC<class_Image_constant_INTERPOLATE_CUBIC>`, but it results in lower quality.

.. _class_Image_constant_INTERPOLATE_CUBIC:

.. rst-class:: classref-enumeration-constant

:ref:`Interpolation<enum_Image_Interpolation>` **INTERPOLATE_CUBIC** = ``2``

Performs cubic interpolation. If the image is resized, it will be blurry. This mode often gives better results compared to :ref:`INTERPOLATE_BILINEAR<class_Image_constant_INTERPOLATE_BILINEAR>`, at the cost of being slower.

.. _class_Image_constant_INTERPOLATE_TRILINEAR:

.. rst-class:: classref-enumeration-constant

:ref:`Interpolation<enum_Image_Interpolation>` **INTERPOLATE_TRILINEAR** = ``3``

Performs bilinear separately on the two most-suited mipmap levels, then linearly interpolates between them.

It's slower than :ref:`INTERPOLATE_BILINEAR<class_Image_constant_INTERPOLATE_BILINEAR>`, but produces higher-quality results with far fewer aliasing artifacts.

If the image does not have mipmaps, they will be generated and used internally, but no mipmaps will be generated on the resulting image.

\ **Note:** If you intend to scale multiple copies of the original image, it's better to call :ref:`generate_mipmaps<class_Image_method_generate_mipmaps>`] on it in advance, to avoid wasting processing power in generating them again and again.

On the other hand, if the image already has mipmaps, they will be used, and a new set will be generated for the resulting image.

.. _class_Image_constant_INTERPOLATE_LANCZOS:

.. rst-class:: classref-enumeration-constant

:ref:`Interpolation<enum_Image_Interpolation>` **INTERPOLATE_LANCZOS** = ``4``

Performs Lanczos interpolation. This is the slowest image resizing mode, but it typically gives the best results, especially when downscaling images.

.. rst-class:: classref-item-separator

----

.. _enum_Image_AlphaMode:

.. rst-class:: classref-enumeration

enum **AlphaMode**: :ref:`🔗<enum_Image_AlphaMode>`

.. _class_Image_constant_ALPHA_NONE:

.. rst-class:: classref-enumeration-constant

:ref:`AlphaMode<enum_Image_AlphaMode>` **ALPHA_NONE** = ``0``

Image does not have alpha.

.. _class_Image_constant_ALPHA_BIT:

.. rst-class:: classref-enumeration-constant

:ref:`AlphaMode<enum_Image_AlphaMode>` **ALPHA_BIT** = ``1``

Image stores alpha in a single bit.

.. _class_Image_constant_ALPHA_BLEND:

.. rst-class:: classref-enumeration-constant

:ref:`AlphaMode<enum_Image_AlphaMode>` **ALPHA_BLEND** = ``2``

Image uses alpha.

.. rst-class:: classref-item-separator

----

.. _enum_Image_CompressMode:

.. rst-class:: classref-enumeration

enum **CompressMode**: :ref:`🔗<enum_Image_CompressMode>`

.. _class_Image_constant_COMPRESS_S3TC:

.. rst-class:: classref-enumeration-constant

:ref:`CompressMode<enum_Image_CompressMode>` **COMPRESS_S3TC** = ``0``

Use S3TC compression.

.. _class_Image_constant_COMPRESS_ETC:

.. rst-class:: classref-enumeration-constant

:ref:`CompressMode<enum_Image_CompressMode>` **COMPRESS_ETC** = ``1``

Use ETC compression.

.. _class_Image_constant_COMPRESS_ETC2:

.. rst-class:: classref-enumeration-constant

:ref:`CompressMode<enum_Image_CompressMode>` **COMPRESS_ETC2** = ``2``

Use ETC2 compression.

.. _class_Image_constant_COMPRESS_BPTC:

.. rst-class:: classref-enumeration-constant

:ref:`CompressMode<enum_Image_CompressMode>` **COMPRESS_BPTC** = ``3``

Use BPTC compression.

.. _class_Image_constant_COMPRESS_ASTC:

.. rst-class:: classref-enumeration-constant

:ref:`CompressMode<enum_Image_CompressMode>` **COMPRESS_ASTC** = ``4``

Use ASTC compression.

.. _class_Image_constant_COMPRESS_MAX:

.. rst-class:: classref-enumeration-constant

:ref:`CompressMode<enum_Image_CompressMode>` **COMPRESS_MAX** = ``5``

Represents the size of the :ref:`CompressMode<enum_Image_CompressMode>` enum.

.. rst-class:: classref-item-separator

----

.. _enum_Image_UsedChannels:

.. rst-class:: classref-enumeration

enum **UsedChannels**: :ref:`🔗<enum_Image_UsedChannels>`

.. _class_Image_constant_USED_CHANNELS_L:

.. rst-class:: classref-enumeration-constant

:ref:`UsedChannels<enum_Image_UsedChannels>` **USED_CHANNELS_L** = ``0``

The image only uses one channel for luminance (grayscale).

.. _class_Image_constant_USED_CHANNELS_LA:

.. rst-class:: classref-enumeration-constant

:ref:`UsedChannels<enum_Image_UsedChannels>` **USED_CHANNELS_LA** = ``1``

The image uses two channels for luminance and alpha, respectively.

.. _class_Image_constant_USED_CHANNELS_R:

.. rst-class:: classref-enumeration-constant

:ref:`UsedChannels<enum_Image_UsedChannels>` **USED_CHANNELS_R** = ``2``

The image only uses the red channel.

.. _class_Image_constant_USED_CHANNELS_RG:

.. rst-class:: classref-enumeration-constant

:ref:`UsedChannels<enum_Image_UsedChannels>` **USED_CHANNELS_RG** = ``3``

The image uses two channels for red and green.

.. _class_Image_constant_USED_CHANNELS_RGB:

.. rst-class:: classref-enumeration-constant

:ref:`UsedChannels<enum_Image_UsedChannels>` **USED_CHANNELS_RGB** = ``4``

The image uses three channels for red, green, and blue.

.. _class_Image_constant_USED_CHANNELS_RGBA:

.. rst-class:: classref-enumeration-constant

:ref:`UsedChannels<enum_Image_UsedChannels>` **USED_CHANNELS_RGBA** = ``5``

The image uses four channels for red, green, blue, and alpha.

.. rst-class:: classref-item-separator

----

.. _enum_Image_CompressSource:

.. rst-class:: classref-enumeration

enum **CompressSource**: :ref:`🔗<enum_Image_CompressSource>`

.. _class_Image_constant_COMPRESS_SOURCE_GENERIC:

.. rst-class:: classref-enumeration-constant

:ref:`CompressSource<enum_Image_CompressSource>` **COMPRESS_SOURCE_GENERIC** = ``0``

Source texture (before compression) is a regular texture. Default for all textures.

.. _class_Image_constant_COMPRESS_SOURCE_SRGB:

.. rst-class:: classref-enumeration-constant

:ref:`CompressSource<enum_Image_CompressSource>` **COMPRESS_SOURCE_SRGB** = ``1``

Source texture (before compression) is in sRGB space.

.. _class_Image_constant_COMPRESS_SOURCE_NORMAL:

.. rst-class:: classref-enumeration-constant

:ref:`CompressSource<enum_Image_CompressSource>` **COMPRESS_SOURCE_NORMAL** = ``2``

Source texture (before compression) is a normal texture (e.g. it can be compressed into two channels).

.. rst-class:: classref-item-separator

----

.. _enum_Image_ASTCFormat:

.. rst-class:: classref-enumeration

enum **ASTCFormat**: :ref:`🔗<enum_Image_ASTCFormat>`

.. _class_Image_constant_ASTC_FORMAT_4x4:

.. rst-class:: classref-enumeration-constant

:ref:`ASTCFormat<enum_Image_ASTCFormat>` **ASTC_FORMAT_4x4** = ``0``

Hint to indicate that the high quality 4×4 ASTC compression format should be used.

.. _class_Image_constant_ASTC_FORMAT_8x8:

.. rst-class:: classref-enumeration-constant

:ref:`ASTCFormat<enum_Image_ASTCFormat>` **ASTC_FORMAT_8x8** = ``1``

Hint to indicate that the low quality 8×8 ASTC compression format should be used.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Constants
---------

.. _class_Image_constant_MAX_WIDTH:

.. rst-class:: classref-constant

**MAX_WIDTH** = ``16777216`` :ref:`🔗<class_Image_constant_MAX_WIDTH>`

The maximal width allowed for **Image** resources.

.. _class_Image_constant_MAX_HEIGHT:

.. rst-class:: classref-constant

**MAX_HEIGHT** = ``16777216`` :ref:`🔗<class_Image_constant_MAX_HEIGHT>`

The maximal height allowed for **Image** resources.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_Image_property_data:

.. rst-class:: classref-property

:ref:`Dictionary<class_Dictionary>` **data** = ``{ "data": PackedByteArray(), "format": "Lum8", "height": 0, "mipmaps": false, "width": 0 }`` :ref:`🔗<class_Image_property_data>`

Holds all the image's color data in a given format. See :ref:`Format<enum_Image_Format>` constants.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_Image_method_adjust_bcs:

.. rst-class:: classref-method

|void| **adjust_bcs**\ (\ brightness\: :ref:`float<class_float>`, contrast\: :ref:`float<class_float>`, saturation\: :ref:`float<class_float>`\ ) :ref:`🔗<class_Image_method_adjust_bcs>`

Adjusts this image's ``brightness``, ``contrast``, and ``saturation`` by the given values. Does not work if the image is compressed (see :ref:`is_compressed<class_Image_method_is_compressed>`).

.. rst-class:: classref-item-separator

----

.. _class_Image_method_blend_rect:

.. rst-class:: classref-method

|void| **blend_rect**\ (\ src\: :ref:`Image<class_Image>`, src_rect\: :ref:`Rect2i<class_Rect2i>`, dst\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`🔗<class_Image_method_blend_rect>`

Alpha-blends ``src_rect`` from ``src`` image to this image at coordinates ``dst``, clipped accordingly to both image bounds. This image and ``src`` image **must** have the same format. ``src_rect`` with non-positive size is treated as empty.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_blend_rect_mask:

.. rst-class:: classref-method

|void| **blend_rect_mask**\ (\ src\: :ref:`Image<class_Image>`, mask\: :ref:`Image<class_Image>`, src_rect\: :ref:`Rect2i<class_Rect2i>`, dst\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`🔗<class_Image_method_blend_rect_mask>`

Alpha-blends ``src_rect`` from ``src`` image to this image using ``mask`` image at coordinates ``dst``, clipped accordingly to both image bounds. Alpha channels are required for both ``src`` and ``mask``. ``dst`` pixels and ``src`` pixels will blend if the corresponding mask pixel's alpha value is not 0. This image and ``src`` image **must** have the same format. ``src`` image and ``mask`` image **must** have the same size (width and height) but they can have different formats. ``src_rect`` with non-positive size is treated as empty.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_blit_rect:

.. rst-class:: classref-method

|void| **blit_rect**\ (\ src\: :ref:`Image<class_Image>`, src_rect\: :ref:`Rect2i<class_Rect2i>`, dst\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`🔗<class_Image_method_blit_rect>`

Copies ``src_rect`` from ``src`` image to this image at coordinates ``dst``, clipped accordingly to both image bounds. This image and ``src`` image **must** have the same format. ``src_rect`` with non-positive size is treated as empty.

\ **Note:** The alpha channel data in ``src`` will overwrite the corresponding data in this image at the target position. To blend alpha channels, use :ref:`blend_rect<class_Image_method_blend_rect>` instead.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_blit_rect_mask:

.. rst-class:: classref-method

|void| **blit_rect_mask**\ (\ src\: :ref:`Image<class_Image>`, mask\: :ref:`Image<class_Image>`, src_rect\: :ref:`Rect2i<class_Rect2i>`, dst\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`🔗<class_Image_method_blit_rect_mask>`

Blits ``src_rect`` area from ``src`` image to this image at the coordinates given by ``dst``, clipped accordingly to both image bounds. ``src`` pixel is copied onto ``dst`` if the corresponding ``mask`` pixel's alpha value is not 0. This image and ``src`` image **must** have the same format. ``src`` image and ``mask`` image **must** have the same size (width and height) but they can have different formats. ``src_rect`` with non-positive size is treated as empty.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_bump_map_to_normal_map:

.. rst-class:: classref-method

|void| **bump_map_to_normal_map**\ (\ bump_scale\: :ref:`float<class_float>` = 1.0\ ) :ref:`🔗<class_Image_method_bump_map_to_normal_map>`

Converts a bump map to a normal map. A bump map provides a height offset per-pixel, while a normal map provides a normal direction per pixel.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_clear_mipmaps:

.. rst-class:: classref-method

|void| **clear_mipmaps**\ (\ ) :ref:`🔗<class_Image_method_clear_mipmaps>`

Removes the image's mipmaps.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_compress:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **compress**\ (\ mode\: :ref:`CompressMode<enum_Image_CompressMode>`, source\: :ref:`CompressSource<enum_Image_CompressSource>` = 0, astc_format\: :ref:`ASTCFormat<enum_Image_ASTCFormat>` = 0\ ) :ref:`🔗<class_Image_method_compress>`

Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available.

The ``source`` parameter helps to pick the best compression method for DXT and ETC2 formats. It is ignored for ASTC compression.

For ASTC compression, the ``astc_format`` parameter must be supplied.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_compress_from_channels:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **compress_from_channels**\ (\ mode\: :ref:`CompressMode<enum_Image_CompressMode>`, channels\: :ref:`UsedChannels<enum_Image_UsedChannels>`, astc_format\: :ref:`ASTCFormat<enum_Image_ASTCFormat>` = 0\ ) :ref:`🔗<class_Image_method_compress_from_channels>`

Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available.

This is an alternative to :ref:`compress<class_Image_method_compress>` that lets the user supply the channels used in order for the compressor to pick the best DXT and ETC2 formats. For other formats (non DXT or ETC2), this argument is ignored.

For ASTC compression, the ``astc_format`` parameter must be supplied.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_compute_image_metrics:

.. rst-class:: classref-method

:ref:`Dictionary<class_Dictionary>` **compute_image_metrics**\ (\ compared_image\: :ref:`Image<class_Image>`, use_luma\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_Image_method_compute_image_metrics>`

Compute image metrics on the current image and the compared image.

The dictionary contains ``max``, ``mean``, ``mean_squared``, ``root_mean_squared`` and ``peak_snr``.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_convert:

.. rst-class:: classref-method

|void| **convert**\ (\ format\: :ref:`Format<enum_Image_Format>`\ ) :ref:`🔗<class_Image_method_convert>`

Converts the image's format. See :ref:`Format<enum_Image_Format>` constants.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_copy_from:

.. rst-class:: classref-method

|void| **copy_from**\ (\ src\: :ref:`Image<class_Image>`\ ) :ref:`🔗<class_Image_method_copy_from>`

Copies ``src`` image to this image.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_create:

.. rst-class:: classref-method

:ref:`Image<class_Image>` **create**\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, use_mipmaps\: :ref:`bool<class_bool>`, format\: :ref:`Format<enum_Image_Format>`\ ) |static| :ref:`🔗<class_Image_method_create>`

**Deprecated:** Use :ref:`create_empty<class_Image_method_create_empty>`.

Creates an empty image of given size and format. See :ref:`Format<enum_Image_Format>` constants. If ``use_mipmaps`` is ``true``, then generate mipmaps for this image. See the :ref:`generate_mipmaps<class_Image_method_generate_mipmaps>`.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_create_empty:

.. rst-class:: classref-method

:ref:`Image<class_Image>` **create_empty**\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, use_mipmaps\: :ref:`bool<class_bool>`, format\: :ref:`Format<enum_Image_Format>`\ ) |static| :ref:`🔗<class_Image_method_create_empty>`

Creates an empty image of given size and format. See :ref:`Format<enum_Image_Format>` constants. If ``use_mipmaps`` is ``true``, then generate mipmaps for this image. See the :ref:`generate_mipmaps<class_Image_method_generate_mipmaps>`.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_create_from_data:

.. rst-class:: classref-method

:ref:`Image<class_Image>` **create_from_data**\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, use_mipmaps\: :ref:`bool<class_bool>`, format\: :ref:`Format<enum_Image_Format>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |static| :ref:`🔗<class_Image_method_create_from_data>`

Creates a new image of given size and format. See :ref:`Format<enum_Image_Format>` constants. Fills the image with the given raw data. If ``use_mipmaps`` is ``true`` then loads mipmaps for this image from ``data``. See :ref:`generate_mipmaps<class_Image_method_generate_mipmaps>`.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_crop:

.. rst-class:: classref-method

|void| **crop**\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`\ ) :ref:`🔗<class_Image_method_crop>`

Crops the image to the given ``width`` and ``height``. If the specified size is larger than the current size, the extra area is filled with black pixels.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_decompress:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **decompress**\ (\ ) :ref:`🔗<class_Image_method_decompress>`

Decompresses the image if it is VRAM compressed in a supported format. Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if the format is supported, otherwise :ref:`@GlobalScope.ERR_UNAVAILABLE<class_@GlobalScope_constant_ERR_UNAVAILABLE>`.

\ **Note:** The following formats can be decompressed: DXT, RGTC, BPTC. The formats ETC1 and ETC2 are not supported.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_detect_alpha:

.. rst-class:: classref-method

:ref:`AlphaMode<enum_Image_AlphaMode>` **detect_alpha**\ (\ ) |const| :ref:`🔗<class_Image_method_detect_alpha>`

Returns :ref:`ALPHA_BLEND<class_Image_constant_ALPHA_BLEND>` if the image has data for alpha values. Returns :ref:`ALPHA_BIT<class_Image_constant_ALPHA_BIT>` if all the alpha values are stored in a single bit. Returns :ref:`ALPHA_NONE<class_Image_constant_ALPHA_NONE>` if no data for alpha values is found.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_detect_used_channels:

.. rst-class:: classref-method

:ref:`UsedChannels<enum_Image_UsedChannels>` **detect_used_channels**\ (\ source\: :ref:`CompressSource<enum_Image_CompressSource>` = 0\ ) |const| :ref:`🔗<class_Image_method_detect_used_channels>`

Returns the color channels used by this image, as one of the :ref:`UsedChannels<enum_Image_UsedChannels>` constants. If the image is compressed, the original ``source`` must be specified.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_fill:

.. rst-class:: classref-method

|void| **fill**\ (\ color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_Image_method_fill>`

Fills the image with ``color``.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_fill_rect:

.. rst-class:: classref-method

|void| **fill_rect**\ (\ rect\: :ref:`Rect2i<class_Rect2i>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_Image_method_fill_rect>`

Fills ``rect`` with ``color``.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_fix_alpha_edges:

.. rst-class:: classref-method

|void| **fix_alpha_edges**\ (\ ) :ref:`🔗<class_Image_method_fix_alpha_edges>`

Blends low-alpha pixels with nearby pixels.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_flip_x:

.. rst-class:: classref-method

|void| **flip_x**\ (\ ) :ref:`🔗<class_Image_method_flip_x>`

Flips the image horizontally.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_flip_y:

.. rst-class:: classref-method

|void| **flip_y**\ (\ ) :ref:`🔗<class_Image_method_flip_y>`

Flips the image vertically.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_generate_mipmaps:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **generate_mipmaps**\ (\ renormalize\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_Image_method_generate_mipmaps>`

Generates mipmaps for the image. Mipmaps are precalculated lower-resolution copies of the image that are automatically used if the image needs to be scaled down when rendered. They help improve image quality and performance when rendering. This method returns an error if the image is compressed, in a custom format, or if the image's width/height is ``0``. Enabling ``renormalize`` when generating mipmaps for normal map textures will make sure all resulting vector values are normalized.

It is possible to check if the image has mipmaps by calling :ref:`has_mipmaps<class_Image_method_has_mipmaps>` or :ref:`get_mipmap_count<class_Image_method_get_mipmap_count>`. Calling :ref:`generate_mipmaps<class_Image_method_generate_mipmaps>` on an image that already has mipmaps will replace existing mipmaps in the image.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_get_data:

.. rst-class:: classref-method

:ref:`PackedByteArray<class_PackedByteArray>` **get_data**\ (\ ) |const| :ref:`🔗<class_Image_method_get_data>`

Returns a copy of the image's raw data.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_get_data_size:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_data_size**\ (\ ) |const| :ref:`🔗<class_Image_method_get_data_size>`

Returns size (in bytes) of the image's raw data.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_get_format:

.. rst-class:: classref-method

:ref:`Format<enum_Image_Format>` **get_format**\ (\ ) |const| :ref:`🔗<class_Image_method_get_format>`

Returns the image's format. See :ref:`Format<enum_Image_Format>` constants.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_get_height:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_height**\ (\ ) |const| :ref:`🔗<class_Image_method_get_height>`

Returns the image's height.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_get_mipmap_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_mipmap_count**\ (\ ) |const| :ref:`🔗<class_Image_method_get_mipmap_count>`

Returns the number of mipmap levels or 0 if the image has no mipmaps. The largest main level image is not counted as a mipmap level by this method, so if you want to include it you can add 1 to this count.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_get_mipmap_offset:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_mipmap_offset**\ (\ mipmap\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_Image_method_get_mipmap_offset>`

Returns the offset where the image's mipmap with index ``mipmap`` is stored in the :ref:`data<class_Image_property_data>` dictionary.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_get_pixel:

.. rst-class:: classref-method

:ref:`Color<class_Color>` **get_pixel**\ (\ x\: :ref:`int<class_int>`, y\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_Image_method_get_pixel>`

Returns the color of the pixel at ``(x, y)``.

This is the same as :ref:`get_pixelv<class_Image_method_get_pixelv>`, but with two integer arguments instead of a :ref:`Vector2i<class_Vector2i>` argument.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_get_pixelv:

.. rst-class:: classref-method

:ref:`Color<class_Color>` **get_pixelv**\ (\ point\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`🔗<class_Image_method_get_pixelv>`

Returns the color of the pixel at ``point``.

This is the same as :ref:`get_pixel<class_Image_method_get_pixel>`, but with a :ref:`Vector2i<class_Vector2i>` argument instead of two integer arguments.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_get_region:

.. rst-class:: classref-method

:ref:`Image<class_Image>` **get_region**\ (\ region\: :ref:`Rect2i<class_Rect2i>`\ ) |const| :ref:`🔗<class_Image_method_get_region>`

Returns a new **Image** that is a copy of this **Image**'s area specified with ``region``.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_get_size:

.. rst-class:: classref-method

:ref:`Vector2i<class_Vector2i>` **get_size**\ (\ ) |const| :ref:`🔗<class_Image_method_get_size>`

Returns the image's size (width and height).

.. rst-class:: classref-item-separator

----

.. _class_Image_method_get_used_rect:

.. rst-class:: classref-method

:ref:`Rect2i<class_Rect2i>` **get_used_rect**\ (\ ) |const| :ref:`🔗<class_Image_method_get_used_rect>`

Returns a :ref:`Rect2i<class_Rect2i>` enclosing the visible portion of the image, considering each pixel with a non-zero alpha channel as visible.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_get_width:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_width**\ (\ ) |const| :ref:`🔗<class_Image_method_get_width>`

Returns the image's width.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_has_mipmaps:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_mipmaps**\ (\ ) |const| :ref:`🔗<class_Image_method_has_mipmaps>`

Returns ``true`` if the image has generated mipmaps.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_is_compressed:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_compressed**\ (\ ) |const| :ref:`🔗<class_Image_method_is_compressed>`

Returns ``true`` if the image is compressed.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_is_empty:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_empty**\ (\ ) |const| :ref:`🔗<class_Image_method_is_empty>`

Returns ``true`` if the image has no data.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_is_invisible:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_invisible**\ (\ ) |const| :ref:`🔗<class_Image_method_is_invisible>`

Returns ``true`` if all the image's pixels have an alpha value of 0. Returns ``false`` if any pixel has an alpha value higher than 0.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_linear_to_srgb:

.. rst-class:: classref-method

|void| **linear_to_srgb**\ (\ ) :ref:`🔗<class_Image_method_linear_to_srgb>`

Converts the entire image from the linear colorspace to the sRGB colorspace. Only works on images with :ref:`FORMAT_RGB8<class_Image_constant_FORMAT_RGB8>` or :ref:`FORMAT_RGBA8<class_Image_constant_FORMAT_RGBA8>` formats.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_load:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **load**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_Image_method_load>`

Loads an image from file ``path``. See `Supported image formats <../tutorials/assets_pipeline/importing_images.html#supported-image-formats>`__ for a list of supported image formats and limitations.

\ **Warning:** This method should only be used in the editor or in cases when you need to load external images at run-time, such as images located at the ``user://`` directory, and may not work in exported projects.

See also :ref:`ImageTexture<class_ImageTexture>` description for usage examples.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_load_bmp_from_buffer:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **load_bmp_from_buffer**\ (\ buffer\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_Image_method_load_bmp_from_buffer>`

Loads an image from the binary contents of a BMP file.

\ **Note:** Godot's BMP module doesn't support 16-bit per pixel images. Only 1-bit, 4-bit, 8-bit, 24-bit, and 32-bit per pixel images are supported.

\ **Note:** This method is only available in engine builds with the BMP module enabled. By default, the BMP module is enabled, but it can be disabled at build-time using the ``module_bmp_enabled=no`` SCons option.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_load_from_file:

.. rst-class:: classref-method

:ref:`Image<class_Image>` **load_from_file**\ (\ path\: :ref:`String<class_String>`\ ) |static| :ref:`🔗<class_Image_method_load_from_file>`

Creates a new **Image** and loads data from the specified file.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_load_jpg_from_buffer:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **load_jpg_from_buffer**\ (\ buffer\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_Image_method_load_jpg_from_buffer>`

Loads an image from the binary contents of a JPEG file.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_load_ktx_from_buffer:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **load_ktx_from_buffer**\ (\ buffer\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_Image_method_load_ktx_from_buffer>`

Loads an image from the binary contents of a `KTX <https://github.com/KhronosGroup/KTX-Software>`__ file. Unlike most image formats, KTX can store VRAM-compressed data and embed mipmaps.

\ **Note:** Godot's libktx implementation only supports 2D images. Cubemaps, texture arrays, and de-padding are not supported.

\ **Note:** This method is only available in engine builds with the KTX module enabled. By default, the KTX module is enabled, but it can be disabled at build-time using the ``module_ktx_enabled=no`` SCons option.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_load_png_from_buffer:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **load_png_from_buffer**\ (\ buffer\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_Image_method_load_png_from_buffer>`

Loads an image from the binary contents of a PNG file.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_load_svg_from_buffer:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **load_svg_from_buffer**\ (\ buffer\: :ref:`PackedByteArray<class_PackedByteArray>`, scale\: :ref:`float<class_float>` = 1.0\ ) :ref:`🔗<class_Image_method_load_svg_from_buffer>`

Loads an image from the UTF-8 binary contents of an **uncompressed** SVG file (**.svg**).

\ **Note:** Beware when using compressed SVG files (like **.svgz**), they need to be ``decompressed`` before loading.

\ **Note:** This method is only available in engine builds with the SVG module enabled. By default, the SVG module is enabled, but it can be disabled at build-time using the ``module_svg_enabled=no`` SCons option.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_load_svg_from_string:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **load_svg_from_string**\ (\ svg_str\: :ref:`String<class_String>`, scale\: :ref:`float<class_float>` = 1.0\ ) :ref:`🔗<class_Image_method_load_svg_from_string>`

Loads an image from the string contents of an SVG file (**.svg**).

\ **Note:** This method is only available in engine builds with the SVG module enabled. By default, the SVG module is enabled, but it can be disabled at build-time using the ``module_svg_enabled=no`` SCons option.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_load_tga_from_buffer:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **load_tga_from_buffer**\ (\ buffer\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_Image_method_load_tga_from_buffer>`

Loads an image from the binary contents of a TGA file.

\ **Note:** This method is only available in engine builds with the TGA module enabled. By default, the TGA module is enabled, but it can be disabled at build-time using the ``module_tga_enabled=no`` SCons option.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_load_webp_from_buffer:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **load_webp_from_buffer**\ (\ buffer\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_Image_method_load_webp_from_buffer>`

Loads an image from the binary contents of a WebP file.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_normal_map_to_xy:

.. rst-class:: classref-method

|void| **normal_map_to_xy**\ (\ ) :ref:`🔗<class_Image_method_normal_map_to_xy>`

Converts the image's data to represent coordinates on a 3D plane. This is used when the image represents a normal map. A normal map can add lots of detail to a 3D surface without increasing the polygon count.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_premultiply_alpha:

.. rst-class:: classref-method

|void| **premultiply_alpha**\ (\ ) :ref:`🔗<class_Image_method_premultiply_alpha>`

Multiplies color values with alpha values. Resulting color values for a pixel are ``(color * alpha)/256``. See also :ref:`CanvasItemMaterial.blend_mode<class_CanvasItemMaterial_property_blend_mode>`.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_resize:

.. rst-class:: classref-method

|void| **resize**\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, interpolation\: :ref:`Interpolation<enum_Image_Interpolation>` = 1\ ) :ref:`🔗<class_Image_method_resize>`

Resizes the image to the given ``width`` and ``height``. New pixels are calculated using the ``interpolation`` mode defined via :ref:`Interpolation<enum_Image_Interpolation>` constants.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_resize_to_po2:

.. rst-class:: classref-method

|void| **resize_to_po2**\ (\ square\: :ref:`bool<class_bool>` = false, interpolation\: :ref:`Interpolation<enum_Image_Interpolation>` = 1\ ) :ref:`🔗<class_Image_method_resize_to_po2>`

Resizes the image to the nearest power of 2 for the width and height. If ``square`` is ``true`` then set width and height to be the same. New pixels are calculated using the ``interpolation`` mode defined via :ref:`Interpolation<enum_Image_Interpolation>` constants.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_rgbe_to_srgb:

.. rst-class:: classref-method

:ref:`Image<class_Image>` **rgbe_to_srgb**\ (\ ) :ref:`🔗<class_Image_method_rgbe_to_srgb>`

Converts a standard RGBE (Red Green Blue Exponent) image to an sRGB image.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_rotate_90:

.. rst-class:: classref-method

|void| **rotate_90**\ (\ direction\: :ref:`ClockDirection<enum_@GlobalScope_ClockDirection>`\ ) :ref:`🔗<class_Image_method_rotate_90>`

Rotates the image in the specified ``direction`` by ``90`` degrees. The width and height of the image must be greater than ``1``. If the width and height are not equal, the image will be resized.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_rotate_180:

.. rst-class:: classref-method

|void| **rotate_180**\ (\ ) :ref:`🔗<class_Image_method_rotate_180>`

Rotates the image by ``180`` degrees. The width and height of the image must be greater than ``1``.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_save_exr:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **save_exr**\ (\ path\: :ref:`String<class_String>`, grayscale\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`🔗<class_Image_method_save_exr>`

Saves the image as an EXR file to ``path``. If ``grayscale`` is ``true`` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return :ref:`@GlobalScope.ERR_UNAVAILABLE<class_@GlobalScope_constant_ERR_UNAVAILABLE>` if Godot was compiled without the TinyEXR module.

\ **Note:** The TinyEXR module is disabled in non-editor builds, which means :ref:`save_exr<class_Image_method_save_exr>` will return :ref:`@GlobalScope.ERR_UNAVAILABLE<class_@GlobalScope_constant_ERR_UNAVAILABLE>` when it is called from an exported project.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_save_exr_to_buffer:

.. rst-class:: classref-method

:ref:`PackedByteArray<class_PackedByteArray>` **save_exr_to_buffer**\ (\ grayscale\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`🔗<class_Image_method_save_exr_to_buffer>`

Saves the image as an EXR file to a byte array. If ``grayscale`` is ``true`` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return an empty byte array if Godot was compiled without the TinyEXR module.

\ **Note:** The TinyEXR module is disabled in non-editor builds, which means :ref:`save_exr<class_Image_method_save_exr>` will return an empty byte array when it is called from an exported project.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_save_jpg:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **save_jpg**\ (\ path\: :ref:`String<class_String>`, quality\: :ref:`float<class_float>` = 0.75\ ) |const| :ref:`🔗<class_Image_method_save_jpg>`

Saves the image as a JPEG file to ``path`` with the specified ``quality`` between ``0.01`` and ``1.0`` (inclusive). Higher ``quality`` values result in better-looking output at the cost of larger file sizes. Recommended ``quality`` values are between ``0.75`` and ``0.90``. Even at quality ``1.00``, JPEG compression remains lossy.

\ **Note:** JPEG does not save an alpha channel. If the **Image** contains an alpha channel, the image will still be saved, but the resulting JPEG file won't contain the alpha channel.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_save_jpg_to_buffer:

.. rst-class:: classref-method

:ref:`PackedByteArray<class_PackedByteArray>` **save_jpg_to_buffer**\ (\ quality\: :ref:`float<class_float>` = 0.75\ ) |const| :ref:`🔗<class_Image_method_save_jpg_to_buffer>`

Saves the image as a JPEG file to a byte array with the specified ``quality`` between ``0.01`` and ``1.0`` (inclusive). Higher ``quality`` values result in better-looking output at the cost of larger byte array sizes (and therefore memory usage). Recommended ``quality`` values are between ``0.75`` and ``0.90``. Even at quality ``1.00``, JPEG compression remains lossy.

\ **Note:** JPEG does not save an alpha channel. If the **Image** contains an alpha channel, the image will still be saved, but the resulting byte array won't contain the alpha channel.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_save_png:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **save_png**\ (\ path\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_Image_method_save_png>`

Saves the image as a PNG file to the file at ``path``.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_save_png_to_buffer:

.. rst-class:: classref-method

:ref:`PackedByteArray<class_PackedByteArray>` **save_png_to_buffer**\ (\ ) |const| :ref:`🔗<class_Image_method_save_png_to_buffer>`

Saves the image as a PNG file to a byte array.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_save_webp:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **save_webp**\ (\ path\: :ref:`String<class_String>`, lossy\: :ref:`bool<class_bool>` = false, quality\: :ref:`float<class_float>` = 0.75\ ) |const| :ref:`🔗<class_Image_method_save_webp>`

Saves the image as a WebP (Web Picture) file to the file at ``path``. By default it will save lossless. If ``lossy`` is ``true``, the image will be saved lossy, using the ``quality`` setting between ``0.0`` and ``1.0`` (inclusive). Lossless WebP offers more efficient compression than PNG.

\ **Note:** The WebP format is limited to a size of 16383×16383 pixels, while PNG can save larger images.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_save_webp_to_buffer:

.. rst-class:: classref-method

:ref:`PackedByteArray<class_PackedByteArray>` **save_webp_to_buffer**\ (\ lossy\: :ref:`bool<class_bool>` = false, quality\: :ref:`float<class_float>` = 0.75\ ) |const| :ref:`🔗<class_Image_method_save_webp_to_buffer>`

Saves the image as a WebP (Web Picture) file to a byte array. By default it will save lossless. If ``lossy`` is ``true``, the image will be saved lossy, using the ``quality`` setting between ``0.0`` and ``1.0`` (inclusive). Lossless WebP offers more efficient compression than PNG.

\ **Note:** The WebP format is limited to a size of 16383×16383 pixels, while PNG can save larger images.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_set_data:

.. rst-class:: classref-method

|void| **set_data**\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, use_mipmaps\: :ref:`bool<class_bool>`, format\: :ref:`Format<enum_Image_Format>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_Image_method_set_data>`

Overwrites data of an existing **Image**. Non-static equivalent of :ref:`create_from_data<class_Image_method_create_from_data>`.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_set_pixel:

.. rst-class:: classref-method

|void| **set_pixel**\ (\ x\: :ref:`int<class_int>`, y\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_Image_method_set_pixel>`

Sets the :ref:`Color<class_Color>` of the pixel at ``(x, y)`` to ``color``.


.. tabs::

 .. code-tab:: gdscript

    var img_width = 10
    var img_height = 5
    var img = Image.create(img_width, img_height, false, Image.FORMAT_RGBA8)
    
    img.set_pixel(1, 2, Color.RED) # Sets the color at (1, 2) to red.

 .. code-tab:: csharp

    int imgWidth = 10;
    int imgHeight = 5;
    var img = Image.Create(imgWidth, imgHeight, false, Image.Format.Rgba8);
    
    img.SetPixel(1, 2, Colors.Red); // Sets the color at (1, 2) to red.



This is the same as :ref:`set_pixelv<class_Image_method_set_pixelv>`, but with a two integer arguments instead of a :ref:`Vector2i<class_Vector2i>` argument.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_set_pixelv:

.. rst-class:: classref-method

|void| **set_pixelv**\ (\ point\: :ref:`Vector2i<class_Vector2i>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_Image_method_set_pixelv>`

Sets the :ref:`Color<class_Color>` of the pixel at ``point`` to ``color``.


.. tabs::

 .. code-tab:: gdscript

    var img_width = 10
    var img_height = 5
    var img = Image.create(img_width, img_height, false, Image.FORMAT_RGBA8)
    
    img.set_pixelv(Vector2i(1, 2), Color.RED) # Sets the color at (1, 2) to red.

 .. code-tab:: csharp

    int imgWidth = 10;
    int imgHeight = 5;
    var img = Image.Create(imgWidth, imgHeight, false, Image.Format.Rgba8);
    
    img.SetPixelv(new Vector2I(1, 2), Colors.Red); // Sets the color at (1, 2) to red.



This is the same as :ref:`set_pixel<class_Image_method_set_pixel>`, but with a :ref:`Vector2i<class_Vector2i>` argument instead of two integer arguments.

.. rst-class:: classref-item-separator

----

.. _class_Image_method_shrink_x2:

.. rst-class:: classref-method

|void| **shrink_x2**\ (\ ) :ref:`🔗<class_Image_method_shrink_x2>`

Shrinks the image by a factor of 2 on each axis (this divides the pixel count by 4).

.. rst-class:: classref-item-separator

----

.. _class_Image_method_srgb_to_linear:

.. rst-class:: classref-method

|void| **srgb_to_linear**\ (\ ) :ref:`🔗<class_Image_method_srgb_to_linear>`

Converts the raw data from the sRGB colorspace to a linear scale. Only works on images with :ref:`FORMAT_RGB8<class_Image_constant_FORMAT_RGB8>` or :ref:`FORMAT_RGBA8<class_Image_constant_FORMAT_RGBA8>` formats.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`