瀏覽代碼

Improve the documentation related to fullscreen and borderless settings

Hugo Locurcio 5 年之前
父節點
當前提交
a1f81a52df
共有 3 個文件被更改,包括 12 次插入3 次删除
  1. 2 0
      doc/classes/DisplayServer.xml
  2. 8 3
      doc/classes/ProjectSettings.xml
  3. 2 0
      doc/classes/Window.xml

+ 2 - 0
doc/classes/DisplayServer.xml

@@ -1108,6 +1108,8 @@
 		<constant name="WINDOW_MODE_MAXIMIZED" value="2" enum="WindowMode">
 		</constant>
 		<constant name="WINDOW_MODE_FULLSCREEN" value="3" enum="WindowMode">
+			Fullscreen window mode. Note that this is not [i]exclusive[/i] fullscreen. On Windows and Linux, a borderless window is used to emulate fullscreen. On macOS, a new desktop is used to display the running project.
+			Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=https://docs.godotengine.org/en/latest/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode.
 		</constant>
 		<constant name="WINDOW_FLAG_RESIZE_DISABLED" value="0" enum="WindowFlags">
 		</constant>

+ 8 - 3
doc/classes/ProjectSettings.xml

@@ -435,19 +435,24 @@
 			If [code]true[/code], the home indicator is hidden automatically. This only affects iOS devices without a physical home button.
 		</member>
 		<member name="display/window/size/always_on_top" type="bool" setter="" getter="" default="false">
-			Force the window to be always on top.
+			Forces the main window to be always on top.
+			[b]Note:[/b] This setting is ignored on iOS, Android, and HTML5.
 		</member>
 		<member name="display/window/size/borderless" type="bool" setter="" getter="" default="false">
-			Force the window to be borderless.
+			Forces the main window to be borderless.
+			[b]Note:[/b] This setting is ignored on iOS, Android, and HTML5.
 		</member>
 		<member name="display/window/size/fullscreen" type="bool" setter="" getter="" default="false">
-			Sets the window to full screen when it starts.
+			Sets the main window to full screen when the project starts. Note that this is not [i]exclusive[/i] fullscreen. On Windows and Linux, a borderless window is used to emulate fullscreen. On macOS, a new desktop is used to display the running project.
+			Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=https://docs.godotengine.org/en/latest/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode.
+			[b]Note:[/b] This setting is ignored on iOS, Android, and HTML5.
 		</member>
 		<member name="display/window/size/height" type="int" setter="" getter="" default="600">
 			Sets the game's main viewport height. On desktop platforms, this is the default window size. Stretch mode settings also use this as a reference when enabled.
 		</member>
 		<member name="display/window/size/resizable" type="bool" setter="" getter="" default="true">
 			Allows the window to be resizable by default.
+			[b]Note:[/b] This setting is ignored on iOS and Android.
 		</member>
 		<member name="display/window/size/test_height" type="int" setter="" getter="" default="0">
 			If greater than zero, overrides the window height when running the game. Useful for testing stretch modes.

+ 2 - 0
doc/classes/Window.xml

@@ -362,6 +362,8 @@
 		<constant name="MODE_MAXIMIZED" value="2" enum="Mode">
 		</constant>
 		<constant name="MODE_FULLSCREEN" value="3" enum="Mode">
+			Fullscreen window mode. Note that this is not [i]exclusive[/i] fullscreen. On Windows and Linux, a borderless window is used to emulate fullscreen. On macOS, a new desktop is used to display the running project.
+			Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=https://docs.godotengine.org/en/latest/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode.
 		</constant>
 		<constant name="FLAG_RESIZE_DISABLED" value="0" enum="Flags">
 		</constant>