Image datatype.
    public class Image : Resource

Native image datatype. Contains image data, which can be converted to a Texture, and several functions to interact with it. The maximum width and height for an Image is 16384 pixels.

Inheritance Chain

Constructors

    public Image()

Properties

    public Dictionary<object, object> Data { get; set; }

Holds all of the image’s color data in a given format. See FORMAT_* constants.

Methods

    public void BlendRect(Image src, Rect2 srcRect, Vector2 dst)

Alpha-blends srcRect from src image to this image at coordinates dest.

    public void BlendRectMask(Image src, Image mask, Rect2 srcRect, Vector2 dst)

Alpha-blends srcRect from src image to this image using mask image at coordinates dst. 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. src image and mask image must have the same size (width and height) but they can have different formats.

    public void BlitRect(Image src, Rect2 srcRect, Vector2 dst)

Copies srcRect from src image to this image at coordinates dst.

    public void BlitRectMask(Image src, Image mask, Rect2 srcRect, Vector2 dst)

Blits srcRect area from src image to this image at the coordinates given by dst. src pixel is copied onto dst if the corresponding mask pixel’s alpha value is not 0. src image and mask image must have the same size (width and height) but they can have different formats.

    public void ClearMipmaps()

Removes the image’s mipmaps.

    public Error Compress(CompressMode mode, CompressSource source, float lossyQuality)

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 COMPRESS_* constants.

    public void Convert(Format format)

Converts the image’s format. See format constants.

    public void CopyFrom(Image src)

Copies src image to this image.

    public void Create(int width, int height, bool useMipmaps, Format format)

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

    public void CreateFromData(int width, int height, bool useMipmaps, Format format, byte[] data)

Creates a new image of given size and format. See format constants. Fills the image with the given raw data. If useMipmaps is true then generate mipmaps for this image. See the generate_mipmaps method.

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

    public Error Decompress()

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

    public AlphaMode DetectAlpha()

Returns ALPHA_BLEND if the image has data for alpha values. Returns ALPHA_BIT if all the alpha values are below a certain threshold or the maximum value. Returns ALPHA_NONE if no data for alpha values is found.

    public void ExpandX2Hq2x()

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

    public void Fill(Color color)

Fills the image with a given Color.

    public void FixAlphaEdges()

Blends low-alpha pixels with nearby pixels.

    public void FlipX()

Flips the image horizontally.

    public void FlipY()

Flips the image vertically.

    public Error GenerateMipmaps()

Generates mipmaps for the image. Mipmaps are pre-calculated and lower resolution copies of the image. Mipmaps are automatically used if the image needs to be scaled down when rendered. This improves image quality and the performance of the rendering. Returns an error if the image is compressed, in a custom format or if the image’s width/height is 0.

    public byte[] GetData()

Returns the image’s raw data.

    public Format GetFormat()

Returns the image’s format. See FORMAT_* constants.

    public int GetHeight()

Returns the image’s height.

    public int GetMipmapOffset(int mipmap)

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

    public Color GetPixel(int x, int y)

Returns the color of the pixel at (x, y) if the image is locked. If the image is unlocked it always returns a Color with the value (0, 0, 0, 1.0).

    public Image GetRect(Rect2 rect)

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

    public Vector2 GetSize()

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

    public Rect2 GetUsedRect()

Returns a Rect2 enclosing the visible portion of the image.

    public int GetWidth()

Returns the image’s width.

    public bool HasMipmaps()

Returns true if the image has generated mipmaps.

    public bool IsCompressed()

Returns true if the image is compressed.

    public bool IsEmpty()

Returns true if the image has no data.

    public bool IsInvisible()

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.

    public Error Load(string path)

Loads an image from file path.

    public Error LoadJpgFromBuffer(byte[] buffer)

    public Error LoadPngFromBuffer(byte[] buffer)

    public void Lock()

Locks the data for writing access.

    public void NormalmapToXy()

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.

    public void PremultiplyAlpha()

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

    public void Resize(int width, int height, Interpolation interpolation = Interpolation.Bilinear)

Resizes the image to the given width and height. New pixels are calculated using interpolation. See interpolation constants.

    public void ResizeToPo2(bool square = false)

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.

    public Error SavePng(string path)

Saves the image as a PNG file to path.

    public void SetPixel(int x, int y, Color color)

Sets the Color of the pixel at (x, y) if the image is locked. Example:

[codeblock]

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

[/codeblock]

    public void ShrinkX2()

Shrinks the image by a factor of 2.

    public void SrgbToLinear()

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

    public void Unlock()

Unlocks the data and prevents changes.

Inner Types

AlphaMode

Name Value Description
None 0  
Bit 1  
Blend 2  

CompressMode

Name Value Description
S3tc 0  
Pvrtc2 1  
Pvrtc4 2  
Etc 3  
Etc2 4  

CompressSource

Name Value Description
Generic 0  
Srgb 1  
Normal 2  

Format

Name Value Description
L8 0  
La8 1  
R8 2  
Rg8 3  
Rgb8 4  
Rgba8 5  
Rgba4444 6  
Rgba5551 7  
Rf 8  
Rgf 9  
Rgbf 10  
Rgbaf 11  
Rh 12  
Rgh 13  
Rgbh 14  
Rgbah 15  
Rgbe9995 16  
Dxt1 17  
Dxt3 18  
Dxt5 19  
RgtcR 20  
RgtcRg 21  
BptcRgba 22  
BptcRgbf 23  
BptcRgbfu 24  
Pvrtc2 25  
Pvrtc2a 26  
Pvrtc4 27  
Pvrtc4a 28  
Etc 29  
Etc2R11 30  
Etc2R11s 31  
Etc2Rg11 32  
Etc2Rg11s 33  
Etc2Rgb8 34  
Etc2Rgba8 35  
Etc2Rgb8a1 36  
Max 37  

Interpolation

Name Value Description
Nearest 0  
Bilinear 1  
Cubic 2  
Tags: