Browse Source

Merge pull request #8837 from jpaugh/jp/clarify-viewport-vs-window

multiple_resolutions.rst: Clear up confusing terms window and viewport
Matthew 1 year ago
parent
commit
5ae1b4085a
1 changed files with 8 additions and 0 deletions
  1. 8 0
      tutorials/rendering/multiple_resolutions.rst

+ 8 - 0
tutorials/rendering/multiple_resolutions.rst

@@ -72,6 +72,14 @@ that are different from this base size. Godot offers many ways to
 control how the viewport will be resized and stretched to different
 control how the viewport will be resized and stretched to different
 screen sizes.
 screen sizes.
 
 
+.. note::
+
+   On this page, *window* refers to the screen area allotted to your game
+   by the system, while *viewport* refers to the root object (accessible 
+   from ``get_tree().root``) which the game controls to fill this screen area.
+   This viewport is a :ref:`Window <class_Window>` instance. Recall from the
+   :ref:`introduction <doc_viewports>` that *all* Window objects are viewports.
+
 To configure the stretch base size at runtime from a script, use the
 To configure the stretch base size at runtime from a script, use the
 ``get_tree().root.content_scale_size`` property (see
 ``get_tree().root.content_scale_size`` property (see
 :ref:`Window.content_scale_size <class_Window_property_content_scale_size>`).
 :ref:`Window.content_scale_size <class_Window_property_content_scale_size>`).