summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-09-19 20:13:50 +0200
committerGitHub <noreply@github.com>2019-09-19 20:13:50 +0200
commitd55c840a0d44813b3dd9dc5da6bf2bbfd0c0164d (patch)
tree786f49ec3a8cff294f775a90219d213112850ef1
parenta385c8506c8f407bd8f2bbc0928cb0d77f8131af (diff)
parent46d71ee2a15940fc3978d11d2db40b7a36430df4 (diff)
Merge pull request #32153 from Calinou/doc-improve-image-get-pixel
Improve the `Image.get_pixel()` and `Image.get_pixelv()` documentation
-rw-r--r--doc/classes/Image.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml
index 10be66feb8..56cafa9bb6 100644
--- a/doc/classes/Image.xml
+++ b/doc/classes/Image.xml
@@ -252,7 +252,7 @@
<argument index="1" name="y" type="int">
</argument>
<description>
- Returns the color of the pixel at [code](x, y)[/code] if the image is locked. If the image is unlocked it always returns a [Color] with the value [code](0, 0, 0, 1.0)[/code].
+ Returns the color of the pixel at [code](x, y)[/code] if the image is locked. If the image is unlocked, it always returns a [Color] with the value [code](0, 0, 0, 1.0)[/code]. This is the same as [method get_pixelv], but two integer arguments instead of a Vector2 argument.
</description>
</method>
<method name="get_pixelv" qualifiers="const">
@@ -261,6 +261,7 @@
<argument index="0" name="src" type="Vector2">
</argument>
<description>
+ Returns the color of the pixel at [code]src[/code] if the image is locked. If the image is unlocked, it always returns a [Color] with the value [code](0, 0, 0, 1.0)[/code]. This is the same as [method get_pixel], but with a Vector2 argument instead of two integer arguments.
</description>
</method>
<method name="get_rect" qualifiers="const">