summaryrefslogtreecommitdiff
path: root/doc/classes/Image.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-06-24 08:06:01 +0200
committerGitHub <noreply@github.com>2022-06-24 08:06:01 +0200
commit913598fec166b4742c6242f46b8b51a4df30f6fb (patch)
treea8ab02ab3b198dfe2911198fbc087dada1e0c5b3 /doc/classes/Image.xml
parentecf187705eb59632cefa649b0f4b44dd3569c0fb (diff)
parent42f7f0894ed4884a0360ca583c955359e1c90e87 (diff)
Merge pull request #62368 from V-Sekai/exr-bug
Restore the openexr grayscale property.
Diffstat (limited to 'doc/classes/Image.xml')
-rw-r--r--doc/classes/Image.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml
index d2baf78a9e..43b03ce65e 100644
--- a/doc/classes/Image.xml
+++ b/doc/classes/Image.xml
@@ -380,6 +380,14 @@
[b]Note:[/b] The TinyEXR module is disabled in non-editor builds, which means [method save_exr] will return [constant ERR_UNAVAILABLE] when it is called from an exported project.
</description>
</method>
+ <method name="save_exr_to_buffer" qualifiers="const">
+ <return type="PackedByteArray" />
+ <argument index="0" name="grayscale" type="bool" default="false" />
+ <description>
+ Saves the image as an EXR file to a byte array. If [code]grayscale[/code] is [code]true[/code] and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return an empty byte array if Godot was compiled without the TinyEXR module.
+ [b]Note:[/b] The TinyEXR module is disabled in non-editor builds, which means [method save_exr] will return an empty byte array when it is called from an exported project.
+ </description>
+ </method>
<method name="save_jpg" qualifiers="const">
<return type="int" enum="Error" />
<argument index="0" name="path" type="String" />