Clarify the meaning of Stretch Mode/Aspect/Shrink (#1562)

* Clarify the meaning of Stretch Mode/Aspect/Shrink

... using some animated GIFs and more consistent terminology.

tutorials/viewports/multiple_resolutions.rst

@@ -3,20 +3,23 @@
 Multiple resolutions
 ====================
 
-Base resolution
----------------
+Base size
+---------
 
-A base screen resolution for the project can be specified in the project
-settings under ``display``, ``window``
+A base size for the window can be specified in the project settings under
+"Display", "Window".
 
 .. image:: img/screenres.png
 
-However, what it does is not completely obvious. When running on PC, the
-engine will attempt to set this resolution (or use something smaller if
-it fails). On mobile, consoles or devices with a fixed resolution or
-full screen rendering, this resolution will be ignored and the native
-resolution will be used instead. To compensate for this, Godot offers
-many ways to control how the screen will resize and stretch to different
+However, what it does is not completely obvious; the engine will *not*
+attempt to switch the monitor to this resolution. Rather, think of this
+setting as the "design size", i.e. the size of the area that you work
+with in the editor. This setting corresponds directly to the size of the
+blue rectangle in the 2D editor.
+
+There is often a need to support devices with screen and window sizes
+that are different from this base size. Godot offers many ways to
+control how the viewport will be resized and stretched to different
 screen sizes.
 
 Resizing
@@ -44,52 +47,145 @@ of configuration variables that provide several options:
 
 .. image:: img/stretchsettings.png
 
-Stretch mode
-------------
+Stretch Mode
+^^^^^^^^^^^^
 
--  **Disabled**: The first is the stretch mode. By default this is
-   disabled, which means no stretching happens (the bigger the screen or
-   window, the bigger the resolution, always matching pixels 1:1).
--  **2D**: In this mode, the resolution specified in display/width and
-   display/height in the project settings will be stretched to cover the
-   whole screen. This means that 3D will be unaffected (will just render
-   to higher-res) and 2D will also be rendered at higher-res, just
-   enlarged.
--  **Viewport**: Viewport scaling is different, the root
-   :ref:`Viewport <class_Viewport>`
-   is set as a render target, and still renders precisely to the
-   resolution specified in the ``display/`` section of the project
-   settings. Finally, this viewport is copied and scaled to fit the
-   screen. This mode is useful when working with pixel-precise games,
-   or for the sake of rendering to a lower resolution for improving
-   performance.
+The "Stretch Mode" setting defines how the base size is stretched to fit
+the resolution of the window or screen.
 
 .. image:: img/stretch.png
 
-Stretch aspect
---------------
+The animations below use a "base size" of just 16×9 pixels to
+demonstrate the effect of different stretch modes. A single sprite, also
+16×9 pixels in size, covers the entire viewport, and a diagonal
+:ref:`Line2D <class_Line2D>` is added on top of it:
 
--  **Ignore**: Ignore the aspect ratio when stretching the screen. This
-   means that the original resolution will be stretched to fit the new
-   one, even if it's wider or narrower.
--  **Keep**: Keep aspect ratio when stretching the screen. This means
-   that the original resolution will be kept when fitting the new one,
-   and black bars will be added to the sides or the top/bottom of the
-   screen.
--  **Keep Width**: Keep aspect ratio when stretching the screen, but if
-   the resulting screen is taller than the specified resolution, it will
-   be stretched vertically (and more vertical resolution will be
-   reported in the viewport, proportionally). This is usually the best
-   option for creating GUIs or HUDs that scale, so some controls can be
-   anchored to the bottom (:ref:`doc_size_and_anchors`).
--  **Keep Height**: Keep aspect ratio when stretching the screen, but if
-   the resulting screen is wider than the specified resolution, it will
-   be stretched horizontally (and more horizontal resolution will be
-   reported in the viewport, proportionally). This is usually the best
-   option for 2D games that scroll horizontally (like runners or
-   platformers).
--  **Expand**: Keep aspect ratio when stretching the screen, but keep
-   neither width nor height. Depending on the screen aspect ratio, the
-   viewport will either report more horizontal resolution (if the screen
-   is wider than the original resolution) or more vertical resolution
-   (if the screen is taller than the original resolution).
+.. image:: img/stretch_demo_scene.png
+
+.. Animated GIFs are generated from:
+.. https://github.com/ttencate/godot_scaling_mode
+
+-  Stretch Mode = **Disabled** (default): No stretching happens. One
+   unit in the scene corresponds to one pixel on the screen. In this
+   mode, the "Stretch Aspect" setting has no effect.
+
+   This is a good option if you want full control over every screen
+   pixel, and is probably the best option for 3D games.
+
+   .. image:: img/stretch_disabled_expand.gif
+
+-  Stretch Mode = **2D**: In this mode, the size specified in
+   display/width and display/height in the project settings will be
+   stretched to cover the whole screen (taking the "Stretch Aspect"
+   setting into account). This means that everything will be rendered
+   directly at the target resolution. 3D will be largely unaffected,
+   while in 2D there is no longer a 1:1 correspondence between sprite
+   pixels and screen pixels, which may result in scaling artifacts.
+   
+   This is a good option if your 2D artwork has a sufficiently high
+   resolution and does not require pixel-perfect rendering. Consider
+   enabling texture filtering and mipmapping on your 2D textures and
+   fonts.
+
+   .. image:: img/stretch_2d_expand.gif
+
+-  Stretch Mode = **Viewport**: Viewport scaling means that the size of
+   the root :ref:`Viewport <class_Viewport>` is set precisely to the
+   base size specified in the "Display" section of the project settings.
+   The scene is rendered to this viewport first. Finally, this viewport
+   is scaled to fit the screen (taking the "Stretch Aspect" setting into
+   account).
+
+   This mode is useful when working with pixel-precise games, or for the
+   sake of rendering to a lower resolution for improving performance.
+
+   .. image:: img/stretch_viewport_expand.gif
+
+Stretch Aspect
+^^^^^^^^^^^^^^
+
+The second setting is the stretch aspect. Note that this only takes effect if
+"Stretch Mode" is set to something other than "disabled".
+
+In the animations below, you will notice gray and black areas. The black
+areas are added by the engine and cannot be drawn into. The gray areas
+are part of your scene, and can be drawn to. The gray areas correspond
+to the region outside the blue frame you see in the 2D editor.
+
+-  Stretch Aspect = **Ignore**: Ignore the aspect ratio when stretching
+   the screen. This means that the original resolution will be stretched
+   to exactly fill the screen, even if it's wider or narrower. This may
+   result in nonuniform stretching: things looking wider or taller than
+   designed.
+
+   .. image:: img/stretch_viewport_ignore.gif
+
+-  Stretch Aspect = **Keep**: Keep aspect ratio when stretching the
+   screen. This means that the viewport retains its original size
+   regardless of the screen resolution, and black bars will be added to
+   the top/bottom of the screen ("letterboxing") or the sides
+   ("pillarboxing").
+
+   This is a good option if you know the aspect ratio of your target
+   devices in advance, or if you don't want to handle different aspect
+   ratios.
+
+   .. image:: img/stretch_viewport_keep.gif
+
+-  Stretch Aspect = **Keep Width**: Keep aspect ratio when stretching the
+   screen. If the screen is wider than the base size, black bars are
+   added at the left and right (pillarboxing). But if the screen is
+   taller than the base resolution, the viewport will be grown in the
+   vertical direction (and more content will be visible to the bottom).
+   You can also think of this as "Expand Vertically".
+   
+   This is usually the best option for creating GUIs or HUDs that scale,
+   so some controls can be anchored to the bottom
+   (:ref:`doc_size_and_anchors`).
+
+   .. image:: img/stretch_viewport_keep_width.gif
+
+-  Stretch Aspect = **Keep Height**: Keep aspect ratio when stretching
+   the screen. If the the screen is taller than the base size, black
+   bars are added at the top and bottom (letterboxing). But if the
+   screen is wider than the base resolution, the viewport will be grown
+   in the horizontal direction (and more content will be visible to the
+   right). You can also think of this as "Expand Horizontally".
+   
+   This is usually the best option for 2D games that scroll horizontally
+   (like runners or platformers).
+
+   .. image:: img/stretch_viewport_keep_height.gif
+
+-  Stretch Aspect = **Expand**: Keep aspect ratio when stretching the
+   screen, but keep neither the base width nor height. Depending on the
+   screen aspect ratio, the viewport will either be larger in the
+   horizontal direction (if the screen is wider than the base size) or
+   in the vertical direction (if the screen is taller than the original
+   size).
+
+   .. image:: img/stretch_viewport_expand.gif
+
+Stretch Shrink
+^^^^^^^^^^^^^^
+
+The "Shrink" setting allows you to add an extra scaling factor on top of
+what the "Stretch" options above already provide. The default value of 1
+means that no scaling occurs.
+
+If, for example, you set "Shrink" to 4 and leave "Stretch Mode" on
+"Disabled", each unit in your scene will correspond to 4×4 pixels on the
+screen.
+
+If "Stretch Mode" is set to something other than "Disabled", the size of
+the root viewport is scaled down by the "Shrink" factor, and pixels in
+the output are scaled up by the same amount. This is rarely useful for
+2D games, but can be used to increase performance in 3D games by
+rendering them at a lower resolution.
+
+From scripts
+^^^^^^^^^^^^
+
+To configure stretching at runtime from a script, use the
+``get_tree().set_screen_stretch()`` function (see
+:ref:`SceneTree.set_screen_stretch<class_SceneTree_set_screen_stretch>`).