From 868a26d0ac111612805030b7c55f50a02a9dbf56 Mon Sep 17 00:00:00 2001
From: Jordyfel <jord_id@abv.bg>
Date: Wed, 30 Aug 2023 20:39:43 +0300
Subject: [PATCH] Document integer scaling functionality and limitation.

---
 doc/classes/ProjectSettings.xml | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index d5495ff7dcf2..637ec794b1f7 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -822,6 +822,9 @@
 		</member>
 		<member name="display/window/stretch/scale_mode" type="String" setter="" getter="" default="&quot;fractional&quot;">
 			The policy to use to determine the final scale factor for 2D elements. This affects how [member display/window/stretch/scale] is applied, in addition to the automatic scale factor determined by [member display/window/stretch/mode].
+			[b]"fractional"[/b]: The scale factor will not be modified.
+			[b]"integer"[/b]: The scale factor will be floored to an integer value, which means that the screen size will always be an integer multiple of the base viewport size. This provides a crisp pixel art appearance.
+			[b]Note:[/b] When using integer scaling with a stretch mode, resizing the window to be smaller than the base viewport size will clip the contents. Consider preventing that by setting [member Window.min_size] to the same value as the base viewport size defined in [member display/window/size/viewport_width] and [member display/window/size/viewport_height].
 		</member>
 		<member name="display/window/subwindows/embed_subwindows" type="bool" setter="" getter="" default="true">
 			If [code]true[/code] subwindows are embedded in the main window.