From 09b324b5b6b956efb2b4a60bd73916bbaf6ff10f Mon Sep 17 00:00:00 2001
From: 31 <31eee384@gmail.com>
Date: Sat, 13 Jun 2020 17:10:26 -0500
Subject: [PATCH] Fix Image.create_from_data use_mipmaps doc
The Image.create_from_data doc describes the "use_mipmaps" argument as a
way to generate mipmaps, but this method only allocates and loads data.
This can cause confusion, where this function reads more or less data
than expected. Update the doc to be more specific that create_from_data
is loading the mipmaps from the raw data.
---
doc/classes/Image.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml
index aa8c8d2443f..d29fcfd96f0 100644
--- a/doc/classes/Image.xml
+++ b/doc/classes/Image.xml
@@ -154,7 +154,7 @@
- Creates a new image of given size and format. See [enum Format] constants. Fills the image with the given raw data. If [code]use_mipmaps[/code] is [code]true[/code] then generate mipmaps for this image. See the [method generate_mipmaps].
+ Creates a new image of given size and format. See [enum Format] constants. Fills the image with the given raw data. If [code]use_mipmaps[/code] is [code]true[/code] then loads mipmaps for this image from [code]data[/code]. See [method generate_mipmaps].