asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #87920 from kleonc/image-doc-unlocking-methods-3x

Browse source 
[3.x] Document some `Image` methods can unlock it (making `set_pixel` fail)
This commit is contained in:
Rémi Verschelde 2024-02-07 09:41:46 +01:00
commit 6f8d35138b
No known key found for this signature in database
GPG key ID: C3336907360768E1
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/classes/Image.xml
View file

@ -385,6 +385,13 @@
img.unlock() img.unlock()
img.set_pixel(x, y, color) # Does not have an effect img.set_pixel(x, y, color) # Does not have an effect
[/codeblock] [/codeblock]
[b]Note:[/b] Some image methods can leave the image unlocked, making subsequent [method set_pixel] calls fail unless the image is locked again. Methods potentially unlocking the image: [method blend_rect], [method blend_rect_mask], [method blit_rect_mask], [method convert], [method fill], [method fill_rect], [method get_used_rect], and [method rgbe_to_srgb].
[codeblock]
img.lock()
img.set_pixel(x, y, color) # Works
img.fill(color) # Unlocks the image
img.set_pixel(x, y, color) # Does not have an effect
[/codeblock]
</description> </description>
</method> </method>
<method name="set_pixelv"> <method name="set_pixelv">
@ -401,6 +408,13 @@
img.unlock() img.unlock()
img.set_pixelv(Vector2(x, y), color) # Does not have an effect img.set_pixelv(Vector2(x, y), color) # Does not have an effect
[/codeblock] [/codeblock]
[b]Note:[/b] Some image methods can leave the image unlocked, making subsequent [method set_pixelv] calls fail unless the image is locked again. Methods potentially unlocking the image: [method blend_rect], [method blend_rect_mask], [method blit_rect_mask], [method convert], [method fill], [method fill_rect], [method get_used_rect], and [method rgbe_to_srgb].
[codeblock]
img.lock()
img.set_pixelv(Vector2(x, y), color) # Works
img.fill(dcolor) # Unlocks the image
img.set_pixelv(Vector2(x, y), color) # Does not have an effect
[/codeblock]
</description> </description>
</method> </method>
<method name="shrink_x2"> <method name="shrink_x2">