diff options
| author | 31 <31eee384@gmail.com> | 2020-06-13 17:10:26 -0500 |
|---|---|---|
| committer | 31 <31eee384@gmail.com> | 2020-06-13 17:18:02 -0500 |
| commit | 09b324b5b6b956efb2b4a60bd73916bbaf6ff10f (patch) | |
| tree | 76ecb2b7e47ebb25ec5608d7449c55f9fb8d6fdc /doc | |
| parent | 58034f39829b8b95a3e5d4c6e8d1ab0427371548 (diff) | |
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.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Image.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index aa8c8d2443..d29fcfd96f 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -154,7 +154,7 @@ <argument index="4" name="data" type="PackedByteArray"> </argument> <description> - 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]. </description> </method> <method name="crop"> |