From 0209e3790e4ab984b811f2994947ae71eef69b82 Mon Sep 17 00:00:00 2001
From: Hugo Locurcio <hugo.locurcio@hugo.pro>
Date: Tue, 20 Oct 2020 23:25:58 +0200
Subject: Add `Image.load_bmp_from_buffer()` for run-time BMP image loading

This partially addresses
https://github.com/godotengine/godot-proposals/issues/676.
---
 doc/classes/Image.xml | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'doc/classes/Image.xml')

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>
-- 
cgit v1.2.3