Image

Dictionary data = { "data": PackedByteArray(), "format": "Lum8", "height": 0, "mipmaps": false, "width": 0 }

Holds all the image's color data in a given format. See Format constants.

void adjust_bcs(float brightness, float contrast, float saturation)

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

void blend_rect(Image src, Rect2i src_rect, Vector2i dst)

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.

void blend_rect_mask(Image src, Image mask, Rect2i src_rect, Vector2i 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 non-positive size is treated as empty.

void blit_rect(Image src, Rect2i src_rect, Vector2i 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 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.

void blit_rect_mask(Image src, Image mask, Rect2i src_rect, Vector2i 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 non-positive size is treated as empty.

void bump_map_to_normal_map(float bump_scale = 1.0)

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.

void clear_mipmaps()

Removes the image's mipmaps.

int compress(int mode, int source = 0, int astc_format = 0)

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.

int compress_from_channels(int mode, int channels, int astc_format = 0)

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.

Dictionary compute_image_metrics(Image compared_image, bool use_luma)

Compute image metrics on the current image and the compared image. The dictionary contains max, mean, mean_squared, root_mean_squared and peak_snr.

void convert(int format)

Converts this image's format to the given format.

void copy_from(Image src)

Copies src image to this image.

Image create(int width, int height, bool use_mipmaps, int format) static

Creates an empty image of the given size and format. If use_mipmaps is true, generates mipmaps for this image. See the generate_mipmaps().

Image create_empty(int width, int height, bool use_mipmaps, int format) static

Creates an empty image of the given size and format. If use_mipmaps is true, generates mipmaps for this image. See the generate_mipmaps().

Image create_from_data(int width, int height, bool use_mipmaps, int format, PackedByteArray data) static

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

void crop(int width, 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.

int decompress()

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.

int detect_alpha() const

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.

int detect_used_channels(int source = 0) const

Returns the color channels used by this image. If the image is compressed, the original source must be specified.

void fill(Color color)

Fills the image with color.

void fill_rect(Rect2i rect, Color color)

Fills rect with color.

void fix_alpha_edges()

Blends low-alpha pixels with nearby pixels.

void flip_x()

Flips the image horizontally.

void flip_y()

Flips the image vertically.

int generate_mipmaps(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. 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.

PackedByteArray get_data() const

Returns a copy of the image's raw data.

int get_data_size() const

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

int get_format() const

Returns this image's format.

int get_height() const

Returns the image's height.

int get_mipmap_count() const

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.

int get_mipmap_offset(int mipmap) const

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

Color get_pixel(int x, int y) const

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.

Color get_pixelv(Vector2i point) const

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.

Image get_region(Rect2i region) const

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

Vector2i get_size() const

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

Rect2i get_used_rect() const

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

int get_width() const

Returns the image's width.

bool has_mipmaps() const

Returns true if the image has generated mipmaps.

bool is_compressed() const

Returns true if the image is compressed.

bool is_empty() const

Returns true if the image has no data.

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.

void linear_to_srgb()

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

int load(String path)

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.

int load_bmp_from_buffer(PackedByteArray buffer)

Loads an image from the binary contents of a BMP file. Note: Redot'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.

int load_dds_from_buffer(PackedByteArray buffer)

Loads an image from the binary contents of a DDS file. Note: This method is only available in engine builds with the DDS module enabled. By default, the DDS module is enabled, but it can be disabled at build-time using the module_dds_enabled=no SCons option.

Image load_from_file(String path) static

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

int load_gif_from_buffer(PackedByteArray buffer)

Loads an image from the binary contents of a GIF file. Note: This method is only available in engine builds with the GIF module enabled. By default, the GIF module is enabled, but it can be disabled at build-time using the module_gif_enabled=no SCons option.

int load_jpg_from_buffer(PackedByteArray buffer)

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

int load_ktx_from_buffer(PackedByteArray buffer)

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: Redot'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.

int load_png_from_buffer(PackedByteArray buffer)

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

int load_svg_from_buffer(PackedByteArray buffer, float scale = 1.0)

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.

int load_svg_from_string(String svg_str, float scale = 1.0)

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.

int load_tga_from_buffer(PackedByteArray buffer)

Loads an image from the binary contents of a TGA file. Note: This method is only available in engine builds with the TGA module enabled. By default, the TGA module is enabled, but it can be disabled at build-time using the module_tga_enabled=no SCons option.

int load_webp_from_buffer(PackedByteArray buffer)

Loads an image from the binary contents of a WebP file. If the file is animated, this function will load the first frame of the animation.

void normal_map_to_xy()

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

void premultiply_alpha()

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

void resize(int width, int height, int interpolation = 1)

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

void resize_to_po2(bool square = false, int interpolation = 1)

Resizes the image to the nearest power of 2 for the width and height. If square is true, sets width and height to be the same. New pixels are calculated using the interpolation mode defined via Interpolation constants.

Image rgbe_to_srgb()

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

void rotate_90(int direction)

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.

void rotate_180()

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

int save_dds(String path) const

Saves the image as a DDS (DirectDraw Surface) file to path. DDS is a container format that can store textures in various compression formats, such as DXT1, DXT5, or BC7. This function will return ERR_UNAVAILABLE if Redot was compiled without the DDS module. Note: The DDS module may be disabled in certain builds, which means save_dds() will return ERR_UNAVAILABLE when it is called from an exported project.

PackedByteArray save_dds_to_buffer() const

Saves the image as a DDS (DirectDraw Surface) file to a byte array. DDS is a container format that can store textures in various compression formats, such as DXT1, DXT5, or BC7. This function will return an empty byte array if Redot was compiled without the DDS module. Note: The DDS module may be disabled in certain builds, which means save_dds_to_buffer() will return an empty byte array when it is called from an exported project.

int save_exr(String path, 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 ERR_UNAVAILABLE if Redot 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.

PackedByteArray save_exr_to_buffer(bool grayscale = false) const

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 Redot was compiled without the TinyEXR module. Note: The TinyEXR module is disabled in non-editor builds, which means save_exr_to_buffer() will return an empty byte array when it is called from an exported project.

int save_jpg(String path, float quality = 0.75) const

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.

PackedByteArray save_jpg_to_buffer(float quality = 0.75) const

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.

int save_png(String path) const

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

PackedByteArray save_png_to_buffer() const

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

int save_webp(String path, bool lossy = false, float quality = 0.75) const

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.

PackedByteArray save_webp_to_buffer(bool lossy = false, float quality = 0.75) const

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.

void set_data(int width, int height, bool use_mipmaps, int format, PackedByteArray data)

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

void set_pixel(int x, int y, Color color)

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

				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.
				

				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.

void set_pixelv(Vector2i point, Color color)

Sets the Color of the pixel at point to color.

				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.
				

				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.

void shrink_x2()

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

void srgb_to_linear()

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

MAX_WIDTH = 16777216

The maximal width allowed for Image resources.

MAX_HEIGHT = 16777216

The maximal height allowed for Image resources.

FORMAT_L8 = 0

Enum: Format

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

FORMAT_LA8 = 1

Enum: Format

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

FORMAT_R8 = 2

Enum: Format

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

FORMAT_RG8 = 3

Enum: Format

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

FORMAT_RGB8 = 4

Enum: Format

OpenGL texture format RGB with three components, each with a bitdepth of 8. Note: When creating an ImageTexture, an sRGB to linear color space conversion is performed.

FORMAT_RGBA8 = 5

Enum: Format

OpenGL texture format RGBA with four components, each with a bitdepth of 8. Note: When creating an ImageTexture, an sRGB to linear color space conversion is performed.

FORMAT_RGBA4444 = 6

Enum: Format

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

FORMAT_RGB565 = 7

Enum: Format

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

FORMAT_RF = 8

Enum: Format

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

FORMAT_RGF = 9

Enum: Format

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

FORMAT_RGBF = 10

Enum: Format

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

FORMAT_RGBAF = 11

Enum: Format

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

FORMAT_RH = 12

Enum: Format

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

FORMAT_RGH = 13

Enum: Format

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

FORMAT_RGBH = 14

Enum: Format

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

FORMAT_RGBAH = 15

Enum: Format

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

FORMAT_RGBE9995 = 16

Enum: Format

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

FORMAT_DXT1 = 17

Enum: Format

The S3TC 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 ImageTexture, an sRGB to linear color space conversion is performed.

FORMAT_DXT3 = 18

Enum: Format

The S3TC 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 ImageTexture, an sRGB to linear color space conversion is performed.

FORMAT_DXT5 = 19

Enum: Format

The S3TC 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 ImageTexture, an sRGB to linear color space conversion is performed.

FORMAT_RGTC_R = 20

Enum: Format

Texture format that uses Red Green Texture Compression, normalizing the red channel data using the same compression algorithm that DXT5 uses for the alpha channel.

FORMAT_RGTC_RG = 21

Enum: Format

Texture format that uses Red Green Texture Compression, normalizing the red and green channel data using the same compression algorithm that DXT5 uses for the alpha channel.

FORMAT_BPTC_RGBA = 22

Enum: Format

Texture format that uses BPTC compression with unsigned normalized RGBA components. Note: When creating an ImageTexture, an sRGB to linear color space conversion is performed.

FORMAT_BPTC_RGBF = 23

Enum: Format

Texture format that uses BPTC compression with signed floating-point RGB components.

FORMAT_BPTC_RGBFU = 24

Enum: Format

Texture format that uses BPTC compression with unsigned floating-point RGB components.

FORMAT_ETC = 25

Enum: Format

Ericsson Texture Compression format 1, also referred to as "ETC1", and is part of the OpenGL ES graphics standard. This format cannot store an alpha channel.

FORMAT_ETC2_R11 = 26

Enum: Format

Ericsson Texture Compression format 2 (R11_EAC variant), which provides one channel of unsigned data.

FORMAT_ETC2_R11S = 27

Enum: Format

Ericsson Texture Compression format 2 (SIGNED_R11_EAC variant), which provides one channel of signed data.

FORMAT_ETC2_RG11 = 28

Enum: Format

Ericsson Texture Compression format 2 (RG11_EAC variant), which provides two channels of unsigned data.

FORMAT_ETC2_RG11S = 29

Enum: Format

Ericsson Texture Compression format 2 (SIGNED_RG11_EAC variant), which provides two channels of signed data.

FORMAT_ETC2_RGB8 = 30

Enum: Format

Ericsson Texture Compression format 2 (RGB8 variant), which is a follow-up of ETC1 and compresses RGB888 data. Note: When creating an ImageTexture, an sRGB to linear color space conversion is performed.

FORMAT_ETC2_RGBA8 = 31

Enum: Format

Ericsson Texture Compression format 2 (RGBA8variant), which compresses RGBA8888 data with full alpha support. Note: When creating an ImageTexture, an sRGB to linear color space conversion is performed.

FORMAT_ETC2_RGB8A1 = 32

Enum: Format

Ericsson Texture Compression format 2 (RGB8_PUNCHTHROUGH_ALPHA1 variant), which compresses RGBA data to make alpha either fully transparent or fully opaque. Note: When creating an ImageTexture, an sRGB to linear color space conversion is performed.

FORMAT_ETC2_RA_AS_RG = 33

Enum: Format

Ericsson Texture Compression format 2 (RGBA8 variant), which compresses RA data and interprets it as two channels (red and green). See also FORMAT_ETC2_RGBA8.

FORMAT_DXT5_RA_AS_RG = 34

Enum: Format

The S3TC texture format also known as Block Compression 3 or BC3, which compresses RA data and interprets it as two channels (red and green). See also FORMAT_DXT5.

FORMAT_ASTC_4x4 = 35

Enum: Format

Adaptive Scalable Texture Compression. This implements the 4×4 (high quality) mode.

FORMAT_ASTC_4x4_HDR = 36

Enum: Format

Same format as FORMAT_ASTC_4x4, but with the hint to let the GPU know it is used for HDR.

FORMAT_ASTC_8x8 = 37

Enum: Format

Adaptive Scalable Texture Compression. This implements the 8×8 (low quality) mode.

FORMAT_ASTC_8x8_HDR = 38

Enum: Format

Same format as FORMAT_ASTC_8x8, but with the hint to let the GPU know it is used for HDR.

FORMAT_MAX = 39

Enum: Format

Represents the size of the Format enum.

INTERPOLATE_NEAREST = 0

Enum: Interpolation

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

INTERPOLATE_BILINEAR = 1

Enum: Interpolation

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

INTERPOLATE_CUBIC = 2

Enum: Interpolation

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

INTERPOLATE_TRILINEAR = 3

Enum: Interpolation

Performs bilinear separately on the two most-suited mipmap levels, then linearly interpolates between them. It's slower than 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 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.

INTERPOLATE_LANCZOS = 4

Enum: Interpolation

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

ALPHA_NONE = 0

Enum: AlphaMode

Image does not have alpha.

ALPHA_BIT = 1

Enum: AlphaMode

Image stores alpha in a single bit.

ALPHA_BLEND = 2

Enum: AlphaMode

Image uses alpha.

COMPRESS_S3TC = 0

Enum: CompressMode

Use S3TC compression.

COMPRESS_ETC = 1

Enum: CompressMode

Use ETC compression.

COMPRESS_ETC2 = 2

Enum: CompressMode

Use ETC2 compression.

COMPRESS_BPTC = 3

Enum: CompressMode

Use BPTC compression.

COMPRESS_ASTC = 4

Enum: CompressMode

Use ASTC compression.

COMPRESS_MAX = 5

Enum: CompressMode

Represents the size of the CompressMode enum.

USED_CHANNELS_L = 0

Enum: UsedChannels

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

USED_CHANNELS_LA = 1

Enum: UsedChannels

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

USED_CHANNELS_R = 2

Enum: UsedChannels

The image only uses the red channel.

USED_CHANNELS_RG = 3

Enum: UsedChannels

The image uses two channels for red and green.

USED_CHANNELS_RGB = 4

Enum: UsedChannels

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

USED_CHANNELS_RGBA = 5

Enum: UsedChannels

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

COMPRESS_SOURCE_GENERIC = 0

Enum: CompressSource

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

COMPRESS_SOURCE_SRGB = 1

Enum: CompressSource

Source texture (before compression) is in sRGB space.

COMPRESS_SOURCE_NORMAL = 2

Enum: CompressSource

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

ASTC_FORMAT_4x4 = 0

Enum: ASTCFormat

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

ASTC_FORMAT_8x8 = 1

Enum: ASTCFormat

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