Improve clarity in Multiple Resolutions doc #9881
Open
+109
−93
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.
I tried to make this doc page clearer and remove bugs, because I find it hard to understand as is.
The resizing discussion mixed talking about resizing to fit a screen and resizing to fit a window. Because the animated gifs do a great job of demonstrating the Stretch Mode differences using resizing of windows, I changed most "screen" references to "window" references.
Replaced the word "display" with "screen" in most cases, as it's an unneeded synonym that made me wonder if there was a difference.
Corrected several instances of referring to the viewport width and height settings as window width and height, or base window width and base window height.
Standardized referring to "base size" in most places instead of sometimes referring to "viewport size" or to "base window size".
Fleshed out the description of Canvas Item vs Viewport stretch mode. Maybe I made it worse, but I had to go onto reddit to find a clearer description than what existed. What clicked for me was a reddit summary saying "Canvas Items first scales the images, and then renders them. Viewport renders the images, and then scales them." I was then able to (hopefully!) clarify the mode descriptions.
Replaced Keep Height description with basically "like Keep Width but for height", rather than making the user check the copy-and-modified description vs Keep Width's for differences.
Asserted that Stretch Mode=Viewport completely avoids scaling artifacts when Stretch Scale Mode is set to Integer. If I'm wrong, please let me know. It's still not clear to me why the Stretch Mode=Viewport example animated gif never looks fuzzy, assuming the author recorded it using Stretch Scale Mode=Fractional, since the Stretch Scale Mode section seems to imply that random resizing of small resolution sprites should cause artifacts unless Stretch Scale Mode=Integer.
Applied style guide to some long lines.
I may have introduced bugs due to not perfectly understanding the subject matter, and am happy to revise further if you explain what I got wrong.