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/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Image.xml.

.. _class_Image:

Image
=====

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :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:`Sprite<class_Sprite>`), 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>`

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

Properties
----------

.. table::
   :widths: auto

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

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

Methods
-------

.. table::
   :widths: auto

   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`blend_rect<class_Image_method_blend_rect>` **(** :ref:`Image<class_Image>` src, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Vector2<class_Vector2>` dst **)**                                                                                                |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`blend_rect_mask<class_Image_method_blend_rect_mask>` **(** :ref:`Image<class_Image>` src, :ref:`Image<class_Image>` mask, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Vector2<class_Vector2>` dst **)**                                                      |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`blit_rect<class_Image_method_blit_rect>` **(** :ref:`Image<class_Image>` src, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Vector2<class_Vector2>` dst **)**                                                                                                  |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`blit_rect_mask<class_Image_method_blit_rect_mask>` **(** :ref:`Image<class_Image>` src, :ref:`Image<class_Image>` mask, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Vector2<class_Vector2>` dst **)**                                                        |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`bumpmap_to_normalmap<class_Image_method_bumpmap_to_normalmap>` **(** :ref:`float<class_float>` bump_scale=1.0 **)**                                                                                                                                        |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`clear_mipmaps<class_Image_method_clear_mipmaps>` **(** **)**                                                                                                                                                                                               |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`     | :ref:`compress<class_Image_method_compress>` **(** :ref:`CompressMode<enum_Image_CompressMode>` mode, :ref:`CompressSource<enum_Image_CompressSource>` source, :ref:`float<class_float>` lossy_quality **)**                                                     |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`convert<class_Image_method_convert>` **(** :ref:`Format<enum_Image_Format>` format **)**                                                                                                                                                                   |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`copy_from<class_Image_method_copy_from>` **(** :ref:`Image<class_Image>` src **)**                                                                                                                                                                         |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`create<class_Image_method_create>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`Format<enum_Image_Format>` format **)**                                                                     |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`create_from_data<class_Image_method_create_from_data>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`Format<enum_Image_Format>` format, :ref:`PoolByteArray<class_PoolByteArray>` data **)** |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`crop<class_Image_method_crop>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**                                                                                                                                                       |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :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|                                                                                                                                                                                         |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`expand_x2_hq2x<class_Image_method_expand_x2_hq2x>` **(** **)**                                                                                                                                                                                             |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`fill<class_Image_method_fill>` **(** :ref:`Color<class_Color>` color **)**                                                                                                                                                                                 |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`fill_rect<class_Image_method_fill_rect>` **(** :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` 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>` **(** :ref:`bool<class_bool>` renormalize=false **)**                                                                                                                                               |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`get_data<class_Image_method_get_data>` **(** **)** |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_offset<class_Image_method_get_mipmap_offset>` **(** :ref:`int<class_int>` mipmap **)** |const|                                                                                                                                                  |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`                 | :ref:`get_pixel<class_Image_method_get_pixel>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y **)** |const|                                                                                                                                              |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`                 | :ref:`get_pixelv<class_Image_method_get_pixelv>` **(** :ref:`Vector2<class_Vector2>` src **)** |const|                                                                                                                                                           |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Image<class_Image>`                 | :ref:`get_rect<class_Image_method_get_rect>` **(** :ref:`Rect2<class_Rect2>` rect **)** |const|                                                                                                                                                                  |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>`             | :ref:`get_size<class_Image_method_get_size>` **(** **)** |const|                                                                                                                                                                                                 |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Rect2<class_Rect2>`                 | :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|                                                                                                                                                                                         |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`     | :ref:`load<class_Image_method_load>` **(** :ref:`String<class_String>` path **)**                                                                                                                                                                                |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`     | :ref:`load_bmp_from_buffer<class_Image_method_load_bmp_from_buffer>` **(** :ref:`PoolByteArray<class_PoolByteArray>` buffer **)**                                                                                                                                |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`     | :ref:`load_jpg_from_buffer<class_Image_method_load_jpg_from_buffer>` **(** :ref:`PoolByteArray<class_PoolByteArray>` buffer **)**                                                                                                                                |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`     | :ref:`load_png_from_buffer<class_Image_method_load_png_from_buffer>` **(** :ref:`PoolByteArray<class_PoolByteArray>` buffer **)**                                                                                                                                |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`     | :ref:`load_tga_from_buffer<class_Image_method_load_tga_from_buffer>` **(** :ref:`PoolByteArray<class_PoolByteArray>` buffer **)**                                                                                                                                |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`     | :ref:`load_webp_from_buffer<class_Image_method_load_webp_from_buffer>` **(** :ref:`PoolByteArray<class_PoolByteArray>` buffer **)**                                                                                                                              |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`lock<class_Image_method_lock>` **(** **)**                                                                                                                                                                                                                 |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`normalmap_to_xy<class_Image_method_normalmap_to_xy>` **(** **)**                                                                                                                                                                                           |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`premultiply_alpha<class_Image_method_premultiply_alpha>` **(** **)**                                                                                                                                                                                       |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`resize<class_Image_method_resize>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`Interpolation<enum_Image_Interpolation>` interpolation=1 **)**                                                                                   |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`resize_to_po2<class_Image_method_resize_to_po2>` **(** :ref:`bool<class_bool>` square=false, :ref:`Interpolation<enum_Image_Interpolation>` interpolation=1 **)**                                                                                          |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Image<class_Image>`                 | :ref:`rgbe_to_srgb<class_Image_method_rgbe_to_srgb>` **(** **)**                                                                                                                                                                                                 |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`     | :ref:`save_exr<class_Image_method_save_exr>` **(** :ref:`String<class_String>` path, :ref:`bool<class_bool>` grayscale=false **)** |const|                                                                                                                       |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`     | :ref:`save_png<class_Image_method_save_png>` **(** :ref:`String<class_String>` path **)** |const|                                                                                                                                                                |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`save_png_to_buffer<class_Image_method_save_png_to_buffer>` **(** **)** |const|                                                                                                                                                                             |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`set_pixel<class_Image_method_set_pixel>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`Color<class_Color>` color **)**                                                                                                                     |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`set_pixelv<class_Image_method_set_pixelv>` **(** :ref:`Vector2<class_Vector2>` dst, :ref:`Color<class_Color>` color **)**                                                                                                                                  |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`shrink_x2<class_Image_method_shrink_x2>` **(** **)**                                                                                                                                                                                                       |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`srgb_to_linear<class_Image_method_srgb_to_linear>` **(** **)**                                                                                                                                                                                             |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`unlock<class_Image_method_unlock>` **(** **)**                                                                                                                                                                                                             |
   +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

----

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

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

.. _enum_Image_Format:

.. rst-class:: classref-enumeration

enum **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.

\ **Note:** When using the GLES2 backend, this uses the alpha channel instead of the red channel for storage.

.. _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_RGBA5551:

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

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

OpenGL texture format ``GL_RGB5_A1`` where 5 bits of depth for each component of RGB and one bit for alpha.

.. _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_R32F`` 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_RG32F`` 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_RGB32F`` 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_RGBA32F`` 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_PVRTC2:

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

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

Texture format used on PowerVR-supported mobile platforms, uses 2-bit color depth with no alpha. More information can be found `here <https://en.wikipedia.org/wiki/PVRTC>`__.

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

.. _class_Image_constant_FORMAT_PVRTC2A:

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

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

Same as `PVRTC2 <https://en.wikipedia.org/wiki/PVRTC>`__, but with an alpha component.

.. _class_Image_constant_FORMAT_PVRTC4:

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

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

Similar to `PVRTC2 <https://en.wikipedia.org/wiki/PVRTC>`__, but with 4-bit color depth and no alpha.

.. _class_Image_constant_FORMAT_PVRTC4A:

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

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

Same as `PVRTC4 <https://en.wikipedia.org/wiki/PVRTC>`__, but with an alpha component.

.. _class_Image_constant_FORMAT_ETC:

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

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

`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** = ``30``

`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** = ``31``

`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** = ``32``

`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** = ``33``

`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** = ``34``

`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** = ``35``

`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** = ``36``

`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_MAX:

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

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

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**:

.. _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 downscalng images.

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

----

.. _enum_Image_AlphaMode:

.. rst-class:: classref-enumeration

enum **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**:

.. _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_PVRTC2:

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

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

Use PVRTC2 compression.

.. _class_Image_constant_COMPRESS_PVRTC4:

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

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

Use PVRTC4 compression.

.. _class_Image_constant_COMPRESS_ETC:

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

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

Use ETC compression.

.. _class_Image_constant_COMPRESS_ETC2:

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

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

Use ETC2 compression.

.. _class_Image_constant_COMPRESS_BPTC:

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

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

Use BPTC compression.

.. _class_Image_constant_COMPRESS_MAX:

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

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

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

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

----

.. _enum_Image_CompressSource:

.. rst-class:: classref-enumeration

enum **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).

.. _class_Image_constant_COMPRESS_SOURCE_LAYERED:

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

:ref:`CompressSource<enum_Image_CompressSource>` **COMPRESS_SOURCE_LAYERED** = ``3``

Source texture (before compression) is a :ref:`TextureLayered<class_TextureLayered>`.

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

----

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

Constants
---------

.. _class_Image_constant_MAX_WIDTH:

.. rst-class:: classref-constant

**MAX_WIDTH** = ``16384``

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

.. _class_Image_constant_MAX_HEIGHT:

.. rst-class:: classref-constant

**MAX_HEIGHT** = ``16384``

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": PoolByteArray(  ),"format": "Lum8","height": 0,"mipmaps": false,"width": 0}``

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_blend_rect:

.. rst-class:: classref-method

void **blend_rect** **(** :ref:`Image<class_Image>` src, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Vector2<class_Vector2>` dst **)**

Alpha-blends ``src_rect`` from ``src`` image to this image at coordinates ``dest``, clipped accordingly to both image bounds. This image and ``src`` image **must** have the same format. ``src_rect`` with not 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** **(** :ref:`Image<class_Image>` src, :ref:`Image<class_Image>` mask, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Vector2<class_Vector2>` dst **)**

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 not positive size is treated as empty.

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

----

.. _class_Image_method_blit_rect:

.. rst-class:: classref-method

void **blit_rect** **(** :ref:`Image<class_Image>` src, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Vector2<class_Vector2>` dst **)**

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 not positive size is treated as empty.

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

----

.. _class_Image_method_blit_rect_mask:

.. rst-class:: classref-method

void **blit_rect_mask** **(** :ref:`Image<class_Image>` src, :ref:`Image<class_Image>` mask, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Vector2<class_Vector2>` dst **)**

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 not positive size is treated as empty.

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

----

.. _class_Image_method_bumpmap_to_normalmap:

.. rst-class:: classref-method

void **bumpmap_to_normalmap** **(** :ref:`float<class_float>` bump_scale=1.0 **)**

Converts a bumpmap to a normalmap. A bumpmap provides a height offset per-pixel, while a normalmap provides a normal direction per pixel.

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

----

.. _class_Image_method_clear_mipmaps:

.. rst-class:: classref-method

void **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** **(** :ref:`CompressMode<enum_Image_CompressMode>` mode, :ref:`CompressSource<enum_Image_CompressSource>` source, :ref:`float<class_float>` lossy_quality **)**

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. See :ref:`CompressMode<enum_Image_CompressMode>` and :ref:`CompressSource<enum_Image_CompressSource>` constants.

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

----

.. _class_Image_method_convert:

.. rst-class:: classref-method

void **convert** **(** :ref:`Format<enum_Image_Format>` format **)**

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** **(** :ref:`Image<class_Image>` src **)**

Copies ``src`` image to this image.

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

----

.. _class_Image_method_create:

.. rst-class:: classref-method

void **create** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`Format<enum_Image_Format>` format **)**

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

void **create_from_data** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`Format<enum_Image_Format>` format, :ref:`PoolByteArray<class_PoolByteArray>` 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** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**

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** **(** **)**

Decompresses the image if it is compressed. Returns an error if decompress function is not available.

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

----

.. _class_Image_method_detect_alpha:

.. rst-class:: classref-method

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

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_expand_x2_hq2x:

.. rst-class:: classref-method

void **expand_x2_hq2x** **(** **)**

Stretches the image and enlarges it by a factor of 2. No interpolation is done.

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

----

.. _class_Image_method_fill:

.. rst-class:: classref-method

void **fill** **(** :ref:`Color<class_Color>` color **)**

Fills the image with ``color``.

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

----

.. _class_Image_method_fill_rect:

.. rst-class:: classref-method

void **fill_rect** **(** :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color **)**

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

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

----

.. _class_Image_method_fix_alpha_edges:

.. rst-class:: classref-method

void **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** **(** **)**

Flips the image horizontally.

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

----

.. _class_Image_method_flip_y:

.. rst-class:: classref-method

void **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** **(** :ref:`bool<class_bool>` renormalize=false **)**

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``.

\ **Note:** Mipmap generation is done on the CPU, is single-threaded and is *always* done on the main thread. This means generating mipmaps will result in noticeable stuttering during gameplay, even if :ref:`generate_mipmaps<class_Image_method_generate_mipmaps>` is called from a :ref:`Thread<class_Thread>`.

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

----

.. _class_Image_method_get_data:

.. rst-class:: classref-method

:ref:`PoolByteArray<class_PoolByteArray>` **get_data** **(** **)** |const|

Returns a copy 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|

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|

Returns the image's height.

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

----

.. _class_Image_method_get_mipmap_offset:

.. rst-class:: classref-method

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

Returns the offset where the image's mipmap with index ``mipmap`` is stored in the ``data`` dictionary.

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

----

.. _class_Image_method_get_pixel:

.. rst-class:: classref-method

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

Returns the color of the pixel at ``(x, y)`` if the image is locked. If the image is unlocked, it always returns a :ref:`Color<class_Color>` with the value ``(0, 0, 0, 1.0)``. This is the same as :ref:`get_pixelv<class_Image_method_get_pixelv>`, but two integer arguments instead of a Vector2 argument.

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

----

.. _class_Image_method_get_pixelv:

.. rst-class:: classref-method

:ref:`Color<class_Color>` **get_pixelv** **(** :ref:`Vector2<class_Vector2>` src **)** |const|

Returns the color of the pixel at ``src`` if the image is locked. If the image is unlocked, it always returns a :ref:`Color<class_Color>` with the value ``(0, 0, 0, 1.0)``. This is the same as :ref:`get_pixel<class_Image_method_get_pixel>`, but with a Vector2 argument instead of two integer arguments.

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

----

.. _class_Image_method_get_rect:

.. rst-class:: classref-method

:ref:`Image<class_Image>` **get_rect** **(** :ref:`Rect2<class_Rect2>` rect **)** |const|

Returns a new image that is a copy of the image's area specified with ``rect``.

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

----

.. _class_Image_method_get_size:

.. rst-class:: classref-method

:ref:`Vector2<class_Vector2>` **get_size** **(** **)** |const|

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

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

----

.. _class_Image_method_get_used_rect:

.. rst-class:: classref-method

:ref:`Rect2<class_Rect2>` **get_used_rect** **(** **)** |const|

Returns a :ref:`Rect2<class_Rect2>` 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|

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|

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|

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|

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|

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_load:

.. rst-class:: classref-method

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

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** **(** :ref:`PoolByteArray<class_PoolByteArray>` 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.

.. 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** **(** :ref:`PoolByteArray<class_PoolByteArray>` buffer **)**

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

.. 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** **(** :ref:`PoolByteArray<class_PoolByteArray>` buffer **)**

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

.. 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** **(** :ref:`PoolByteArray<class_PoolByteArray>` buffer **)**

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

.. 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** **(** :ref:`PoolByteArray<class_PoolByteArray>` buffer **)**

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

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

----

.. _class_Image_method_lock:

.. rst-class:: classref-method

void **lock** **(** **)**

Locks the data for reading and writing access. Sends an error to the console if the image is not locked when reading or writing a pixel.

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

----

.. _class_Image_method_normalmap_to_xy:

.. rst-class:: classref-method

void **normalmap_to_xy** **(** **)**

Converts the image's data to represent coordinates on a 3D plane. This is used when the image represents a normalmap. A normalmap 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** **(** **)**

Multiplies color values with alpha values. Resulting color values for a pixel are ``(color * alpha)/256``.

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

----

.. _class_Image_method_resize:

.. rst-class:: classref-method

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

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** **(** :ref:`bool<class_bool>` square=false, :ref:`Interpolation<enum_Image_Interpolation>` interpolation=1 **)**

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** **(** **)**

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

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

----

.. _class_Image_method_save_exr:

.. rst-class:: classref-method

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

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_png:

.. rst-class:: classref-method

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

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

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

----

.. _class_Image_method_save_png_to_buffer:

.. rst-class:: classref-method

:ref:`PoolByteArray<class_PoolByteArray>` **save_png_to_buffer** **(** **)** |const|

.. container:: contribute

	There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

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

----

.. _class_Image_method_set_pixel:

.. rst-class:: classref-method

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

Sets the :ref:`Color<class_Color>` of the pixel at ``(x, y)`` if the image is locked. Example:

::

    var img = Image.new()
    img.create(img_width, img_height, false, Image.FORMAT_RGBA8)
    img.lock()
    img.set_pixel(x, y, color) # Works
    img.unlock()
    img.set_pixel(x, y, color) # Does not have an effect

\ **Note:** Some image methods can leave the image unlocked, making subsequent :ref:`set_pixel<class_Image_method_set_pixel>` calls fail unless the image is locked again. Methods potentially unlocking the image: :ref:`blend_rect<class_Image_method_blend_rect>`, :ref:`blend_rect_mask<class_Image_method_blend_rect_mask>`, :ref:`blit_rect_mask<class_Image_method_blit_rect_mask>`, :ref:`convert<class_Image_method_convert>`, :ref:`fill<class_Image_method_fill>`, :ref:`fill_rect<class_Image_method_fill_rect>`, :ref:`get_used_rect<class_Image_method_get_used_rect>`, and :ref:`rgbe_to_srgb<class_Image_method_rgbe_to_srgb>`.

::

    img.lock()
    img.set_pixel(x, y, color) # Works
    img.fill(color) # Unlocks the image
    img.set_pixel(x, y, color) # Does not have an effect

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

----

.. _class_Image_method_set_pixelv:

.. rst-class:: classref-method

void **set_pixelv** **(** :ref:`Vector2<class_Vector2>` dst, :ref:`Color<class_Color>` color **)**

Sets the :ref:`Color<class_Color>` of the pixel at ``(dst.x, dst.y)`` if the image is locked. Note that the ``dst`` values must be integers. Example:

::

    var img = Image.new()
    img.create(img_width, img_height, false, Image.FORMAT_RGBA8)
    img.lock()
    img.set_pixelv(Vector2(x, y), color) # Works
    img.unlock()
    img.set_pixelv(Vector2(x, y), color) # Does not have an effect

\ **Note:** Some image methods can leave the image unlocked, making subsequent :ref:`set_pixelv<class_Image_method_set_pixelv>` calls fail unless the image is locked again. Methods potentially unlocking the image: :ref:`blend_rect<class_Image_method_blend_rect>`, :ref:`blend_rect_mask<class_Image_method_blend_rect_mask>`, :ref:`blit_rect_mask<class_Image_method_blit_rect_mask>`, :ref:`convert<class_Image_method_convert>`, :ref:`fill<class_Image_method_fill>`, :ref:`fill_rect<class_Image_method_fill_rect>`, :ref:`get_used_rect<class_Image_method_get_used_rect>`, and :ref:`rgbe_to_srgb<class_Image_method_rgbe_to_srgb>`.

::

    img.lock()
    img.set_pixelv(Vector2(x, y), color) # Works
    img.fill(dcolor) # Unlocks the image
    img.set_pixelv(Vector2(x, y), color) # Does not have an effect

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

----

.. _class_Image_method_shrink_x2:

.. rst-class:: classref-method

void **shrink_x2** **(** **)**

Shrinks the image by a factor of 2.

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

----

.. _class_Image_method_srgb_to_linear:

.. rst-class:: classref-method

void **srgb_to_linear** **(** **)**

Converts the raw data from the sRGB colorspace to a linear scale.

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

----

.. _class_Image_method_unlock:

.. rst-class:: classref-method

void **unlock** **(** **)**

Unlocks the data and prevents changes.

.. |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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`