Image #

func adjust_bcs(saturation: float) -> void#

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

func blend_rect(dst: Vector2i) -> void#

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.

func blend_rect_mask(dst: Vector2i) -> void#

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.

func blit_rect(dst: Vector2i) -> void#

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 blend_rect instead.

func blit_rect_mask(dst: Vector2i) -> void#

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.

func bump_map_to_normal_map(bump_scale: float = 1.0) -> void#

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.

func clear_mipmaps() -> void#

Removes the image's mipmaps.

func compress(astc_format: int = 0 enumImage.ASTCFormat) -> intError#

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.

func compress_from_channels(astc_format: int = 0 enumImage.ASTCFormat) -> intError#

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

func compute_image_metrics(use_luma: bool) -> Dictionary#

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

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

func convert(format: int enumImage.Format) -> void#

Converts the image's format. See Format constants.

func copy_from(src: Image) -> void#

Copies src image to this image.

static func create(format: int enumImage.Format) -> Image#

Creates an empty image of given size and format. See Format constants. If use_mipmaps is true, then generate mipmaps for this image. See the generate_mipmaps.

static func create_empty(format: int enumImage.Format) -> Image#

Creates an empty image of given size and format. See Format constants. If use_mipmaps is true, then generate mipmaps for this image. See the generate_mipmaps.

static func create_from_data(data: PackedByteArray) -> Image#

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

func crop(height: int) -> void#

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.

func decompress() -> intError#

Decompresses the image if it is VRAM compressed in a supported format. Returns OK if the format is supported, otherwise ERR_UNAVAILABLE.

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

const func detect_alpha() -> intImage.AlphaMode#

Returns ALPHA_BLEND if the image has data for alpha values. Returns ALPHA_BIT if all the alpha values are stored in a single bit. Returns ALPHA_NONE if no data for alpha values is found.

const func detect_used_channels(source: int = 0 enumImage.CompressSource) -> intImage.UsedChannels#

Returns the color channels used by this image, as one of the UsedChannels constants. If the image is compressed, the original source must be specified.

func fill(color: Color) -> void#

Fills the image with color.

func fill_rect(color: Color) -> void#

Fills rect with color.

func fix_alpha_edges() -> void#

Blends low-alpha pixels with nearby pixels.

func flip_x() -> void#

Flips the image horizontally.

func flip_y() -> void#

Flips the image vertically.

func generate_mipmaps(renormalize: bool = false) -> intError#

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 has_mipmaps or get_mipmap_count. Calling generate_mipmaps on an image that already has mipmaps will replace existing mipmaps in the image.

const func get_data() -> PackedByteArray#

Returns a copy of the image's raw data.

const func get_data_size() -> int#

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

const func get_format() -> intImage.Format#

Returns the image's format. See Format constants.

const func get_height() -> int#

Returns the image's height.

const func get_mipmap_count() -> int#

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.

const func get_mipmap_offset(mipmap: int) -> int#

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

const func get_pixel(y: int) -> Color#

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

This is the same as get_pixelv, but with two integer arguments instead of a Vector2i argument.

const func get_pixelv(point: Vector2i) -> Color#

Returns the color of the pixel at point.

This is the same as get_pixel, but with a Vector2i argument instead of two integer arguments.

const func get_region(region: Rect2i) -> Image#

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

const func get_size() -> Vector2i#

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

const func get_used_rect() -> Rect2i#

Returns a Rect2i enclosing the visible portion of the image, considering each pixel with a non-zero alpha channel as visible.

const func get_width() -> int#

Returns the image's width.

const func has_mipmaps() -> bool#

Returns true if the image has generated mipmaps.

const func is_compressed() -> bool#

Returns true if the image is compressed.

const func is_empty() -> bool#

Returns true if the image has no data.

const func is_invisible() -> bool#

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.

func linear_to_srgb() -> void#

Converts the entire image from the linear colorspace to the sRGB colorspace. Only works on images with FORMAT_RGB8 or FORMAT_RGBA8 formats.

func load(path: String) -> intError#

Loads an image from file path. See 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 ImageTexture description for usage examples.

func load_bmp_from_buffer(buffer: PackedByteArray) -> intError#

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.

static func load_from_file(path: String) -> Image#

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

func load_jpg_from_buffer(buffer: PackedByteArray) -> intError#

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

func load_ktx_from_buffer(buffer: PackedByteArray) -> intError#

Loads an image from the binary contents of a KTX 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.

func load_png_from_buffer(buffer: PackedByteArray) -> intError#

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

func load_svg_from_buffer(scale: float = 1.0) -> intError#

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.

func load_svg_from_string(scale: float = 1.0) -> intError#

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.

func load_tga_from_buffer(buffer: PackedByteArray) -> intError#

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.

func load_webp_from_buffer(buffer: PackedByteArray) -> intError#

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

func normal_map_to_xy() -> void#

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.

func premultiply_alpha() -> void#

Multiplies color values with alpha values. Resulting color values for a pixel are (color * alpha)/256. See also CanvasItemMaterial.blend_mode.

func resize(interpolation: int = 1 enumImage.Interpolation) -> void#

Resizes the image to the given width and height. New pixels are calculated using the interpolation mode defined via Interpolation constants.

func resize_to_po2(interpolation: int = 1 enumImage.Interpolation) -> void#

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 Interpolation constants.

func rgbe_to_srgb() -> Image#

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

func rotate_90(direction: int enumClockDirection) -> void#

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.

func rotate_180() -> void#

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

const func save_exr(grayscale: bool = false) -> intError#

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 ERR_UNAVAILABLE if Godot was compiled without the TinyEXR module.

Note: The TinyEXR module is disabled in non-editor builds, which means save_exr will return ERR_UNAVAILABLE when it is called from an exported project.

const func save_exr_to_buffer(grayscale: bool = false) -> PackedByteArray#

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 save_exr will return an empty byte array when it is called from an exported project.

const func save_jpg(quality: float = 0.75) -> intError#

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.

const func save_jpg_to_buffer(quality: float = 0.75) -> PackedByteArray#

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.

const func save_png(path: String) -> intError#

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

const func save_png_to_buffer() -> PackedByteArray#

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

const func save_webp(quality: float = 0.75) -> intError#

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.

const func save_webp_to_buffer(quality: float = 0.75) -> PackedByteArray#

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.

func set_data(data: PackedByteArray) -> void#

Overwrites data of an existing Image. Non-static equivalent of create_from_data.

func set_pixel(color: Color) -> void#

Sets the Color of the pixel at (x, y) to color.

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.

C#

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 set_pixelv, but with a two integer arguments instead of a Vector2i argument.

func set_pixelv(color: Color) -> void#

Sets the Color of the pixel at point to color.

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.

C#

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 set_pixel, but with a Vector2i argument instead of two integer arguments.

func shrink_x2() -> void#

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

func srgb_to_linear() -> void#

Converts the raw data from the sRGB colorspace to a linear scale. Only works on images with FORMAT_RGB8 or FORMAT_RGBA8 formats.