Improve error messages when creating Images from code

[Calinou]

The rationale behind the expected number of bytes is now displayed in clear (width, height, format, number of mipmaps expected if any).

Requested by @2shady4u 🙂

Preview

Testing script

extends Node2D


func _ready():
	var image = Image.new()
	var data = PackedByteArray()
	image.create_from_data(512, 512, false, Image.FORMAT_RGB8, data)

	var image2 = Image.new()
	image2.create_from_data(320, 200, true, Image.FORMAT_L8, data)
	
	var image_small = Image.new()
	image_small.create_from_data(2, 2, true, Image.FORMAT_RGBE9995, data)

	var image_large = Image.new()
	image_large.create(16385, 1, false, Image.FORMAT_L8)
	
	var image_zero = Image.new()
	image_zero.create(0, 0, false, Image.FORMAT_L8)
	
	var image_invalid_format = Image.new()
	image_invalid_format.create(256, 256, false, 9999)

Before

ERROR: Expected data size of 786432 bytes in Image::create(), got instead 0 bytes.
   at: create (core/io/image.cpp:1980)
ERROR: Expected data size of 85318 bytes in Image::create(), got instead 0 bytes.
   at: create (core/io/image.cpp:1980)
ERROR: Expected data size of 20 bytes in Image::create(), got instead 0 bytes.
   at: create (core/io/image.cpp:1980)
ERROR: Image width must be greater than 0.
   at: create (core/io/image.cpp:1947)
ERROR: Image format out of range, please see Image's Format enum.
   at: create (core/io/image.cpp:1952)

After

ERROR: Expected Image data size of 512x512x3 (without mipmaps) = 786432 bytes, got 0 bytes instead.
   at: create (core/io/image.cpp:1999)
ERROR: Expected Image data size of 320x200x1 (with 8 mipmaps) = 85318 bytes, got 0 bytes instead.
   at: create (core/io/image.cpp:1999)
ERROR: Expected Image data size of 2x2x4 (with 1 mipmap) = 20 bytes, got 0 bytes instead.
   at: create (core/io/image.cpp:1999)
ERROR: The Image width specified (0 pixels) must be greater than 0 pixels.
   at: create (core/io/image.cpp:1947)
ERROR: The Image format specified (9999) is out of range. See Image's Format enum.
   at: create (core/io/image.cpp:1955)

[akien-mga]

Thanks!

[akien-mga]

Cherry-picked for 3.5.