Document color format caveats in Image.set_pixel()
#111896
Open
+4
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Calinou
commented
Oct 21, 2025
Calinou
commented
- This closes Explain how Image.set_pixel() works when the image format is not color godot-docs#11399.
Calinou
added
enhancement
documentation
cherrypick:4.4
|
Wow that was fast |
AThousandShips
approved these changes
Oct 22, 2025
| [/csharp] | ||
| [/codeblocks] | ||
| This is the same as [method set_pixelv], but with a two integer arguments instead of a [Vector2i] argument. | ||
| [b]Note:[/b] According to the image's format, the color set here may be clamped or lose precision. Do not assume the color returned by [method get_pixel] to be identical to the one set here; any comparisons will likely need to use an approximation. |
There was a problem hiding this comment.
Suggested change
| [b]Note:[/b] According to the image's format, the color set here may be clamped or lose precision. Do not assume the color returned by [method get_pixel] to be identical to the one set here; any comparisons will likely need to use an approximation. | |
| [b]Note:[/b] Depending on the image's format, the color set here may be clamped or lose precision. Do not assume the color returned by [method get_pixel] to be identical to the one set here; any comparisons will likely need to use an approximation like [method Color.is_equal_approx]. |
I'd say for clarity and wording
| [/csharp] | ||
| [/codeblocks] | ||
| This is the same as [method set_pixel], but with a [Vector2i] argument instead of two integer arguments. | ||
| [b]Note:[/b] According to the image's format, the color set here may be clamped or lose precision. Do not assume the color returned by [method get_pixelv] to be identical to the one set here; any comparisons will likely need to use an approximation. |
There was a problem hiding this comment.
Suggested change
| [b]Note:[/b] According to the image's format, the color set here may be clamped or lose precision. Do not assume the color returned by [method get_pixelv] to be identical to the one set here; any comparisons will likely need to use an approximation. | |
| [b]Note:[/b] Depending on the image's format, the color set here may be clamped or lose precision. Do not assume the color returned by [method get_pixelv] to be identical to the one set here; any comparisons will likely need to use an approximation like [method Color.is_equal_approx]. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.