Browse Source

Add note about alpha channels blending to `Image.blit_rect`

David Rautert 1 year ago
parent
commit
ea2ea58a28
1 changed files with 1 additions and 0 deletions
  1. 1 0
      doc/classes/Image.xml

+ 1 - 0
doc/classes/Image.xml

@@ -48,6 +48,7 @@
 			<param index="2" name="dst" type="Vector2i" />
 			<param index="2" name="dst" type="Vector2i" />
 			<description>
 			<description>
 				Copies [param src_rect] from [param src] image to this image at coordinates [param dst], clipped accordingly to both image bounds. This image and [param src] image [b]must[/b] have the same format. [param src_rect] with non-positive size is treated as empty.
 				Copies [param src_rect] from [param src] image to this image at coordinates [param dst], clipped accordingly to both image bounds. This image and [param src] image [b]must[/b] have the same format. [param src_rect] with non-positive size is treated as empty.
+				[b]Note:[/b] The alpha channel data in [param src] will overwrite the corresponding data in this image at the target position. To blend alpha channels, use [method blend_rect] instead.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="blit_rect_mask">
 		<method name="blit_rect_mask">