summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2020-10-20 23:25:58 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2020-10-20 23:52:45 +0200
commit0209e3790e4ab984b811f2994947ae71eef69b82 (patch)
tree80629af927952617cf9e4a849a55e2a49ac7bdde /doc
parentc77466b2761f28655fa98040e9e92b63e59faa7d (diff)
Add `Image.load_bmp_from_buffer()` for run-time BMP image loading
This partially addresses https://github.com/godotengine/godot-proposals/issues/676.
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Image.xml10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml
index 20be20db34..3b108468de 100644
--- a/doc/classes/Image.xml
+++ b/doc/classes/Image.xml
@@ -346,6 +346,16 @@
Loads an image from file [code]path[/code]. See [url=https://docs.godotengine.org/en/latest/getting_started/workflow/assets/importing_images.html#supported-image-formats]Supported image formats[/url] for a list of supported image formats and limitations.
</description>
</method>
+ <method name="load_bmp_from_buffer">
+ <return type="int" enum="Error">
+ </return>
+ <argument index="0" name="buffer" type="PackedByteArray">
+ </argument>
+ <description>
+ Loads an image from the binary contents of a BMP file.
+ [b]Note:[/b] Godot'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.
+ </description>
+ </method>
<method name="load_jpg_from_buffer">
<return type="int" enum="Error">
</return>