summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSamuel Pedrajas <samuelpedrajaspz@gmail.com>2021-10-25 19:27:12 +0200
committerRémi Verschelde <rverschelde@gmail.com>2022-01-18 23:29:11 +0100
commitfcc9f5ce396ff921ed8253f657a8c9c38e7a878d (patch)
tree014b238b992c8572cfe19014430dc3b1d430e2dc /doc
parent4979d9fc7b0ecc68b8e98d2e98a6595be6bb8992 (diff)
Add new scaling modes for splash screen
Removes the `fullsize` option which is superseded by `stretch_mode`. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/ProjectSettings.xml6
-rw-r--r--doc/classes/RenderingServer.xml22
2 files changed, 23 insertions, 5 deletions
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index 357186b917..bcd576d7ab 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -196,9 +196,6 @@
<member name="application/boot_splash/bg_color" type="Color" setter="" getter="" default="Color(0.14, 0.14, 0.14, 1)">
Background color for the boot splash.
</member>
- <member name="application/boot_splash/fullsize" type="bool" setter="" getter="" default="true">
- If [code]true[/code], scale the boot splash image to the full window size (preserving the aspect ratio) when the engine starts. If [code]false[/code], the engine will leave it at the default pixel size.
- </member>
<member name="application/boot_splash/image" type="String" setter="" getter="" default="&quot;&quot;">
Path to an image used as the boot splash. If left empty, the default Godot Engine splash will be displayed instead.
[b]Note:[/b] Only effective if [member application/boot_splash/show_image] is [code]true[/code].
@@ -206,6 +203,9 @@
<member name="application/boot_splash/show_image" type="bool" setter="" getter="" default="true">
If [code]true[/code], displays the image specified in [member application/boot_splash/image] when the engine starts. If [code]false[/code], only displays the plain color specified in [member application/boot_splash/bg_color].
</member>
+ <member name="application/boot_splash/stretch_mode" type="int" setter="" getter="" default="1">
+ Specifies how the splash image will be stretched. See [enum RenderingServer.SplashStretchMode] constants for more information.
+ </member>
<member name="application/boot_splash/use_filter" type="bool" setter="" getter="" default="true">
If [code]true[/code], applies linear filtering when scaling the image (recommended for high-resolution artwork). If [code]false[/code], uses nearest-neighbor interpolation (recommended for pixel art).
</member>
diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml
index 9e78372013..9c41b7472b 100644
--- a/doc/classes/RenderingServer.xml
+++ b/doc/classes/RenderingServer.xml
@@ -2657,10 +2657,10 @@
<return type="void" />
<argument index="0" name="image" type="Image" />
<argument index="1" name="color" type="Color" />
- <argument index="2" name="scale" type="bool" />
+ <argument index="2" name="stretch_mode" type="int" enum="RenderingServer.SplashStretchMode" />
<argument index="3" name="use_filter" type="bool" default="true" />
<description>
- Sets a boot image. The color defines the background color. If [code]scale[/code] is [code]true[/code], the image will be scaled to fit the screen size. If [code]use_filter[/code] is [code]true[/code], the image will be scaled with linear interpolation. If [code]use_filter[/code] is [code]false[/code], the image will be scaled with nearest-neighbor interpolation.
+ Sets a boot image. The color defines the background color. The value of [code]stretch_mode[/code] indicates how the image will be stretched (see [enum SplashStretchMode] for possible values). If [code]use_filter[/code] is [code]true[/code], the image will be scaled with linear interpolation. If [code]use_filter[/code] is [code]false[/code], the image will be scaled with nearest-neighbor interpolation.
</description>
</method>
<method name="set_debug_generate_wireframes">
@@ -4504,6 +4504,24 @@
</constant>
<constant name="RENDERING_INFO_VIDEO_MEM_USED" value="5" enum="RenderingInfo">
</constant>
+ <constant name="SPLASH_STRETCH_MODE_DISABLED" value="0" enum="SplashStretchMode">
+ The splash image uses its default pixel size.
+ </constant>
+ <constant name="SPLASH_STRETCH_MODE_KEEP" value="1" enum="SplashStretchMode">
+ If the window width is greater than its height, the splash image will be stretched to have the same height as the window. Otherwise, the image will be stretched to have the same width as the window. Both cases keep the original image's aspect ratio.
+ </constant>
+ <constant name="SPLASH_STRETCH_MODE_KEEP_WIDTH" value="2" enum="SplashStretchMode">
+ The splash image is stretched to have the same width as the window. It keeps the image's aspect ratio.
+ </constant>
+ <constant name="SPLASH_STRETCH_MODE_KEEP_HEIGHT" value="3" enum="SplashStretchMode">
+ The splash image is stretched to have the same height as the window. It keeps the image's aspect ratio.
+ </constant>
+ <constant name="SPLASH_STRETCH_MODE_COVER" value="4" enum="SplashStretchMode">
+ The splash image covers the window while keeping the aspect ratio.
+ </constant>
+ <constant name="SPLASH_STRETCH_MODE_EXPAND" value="5" enum="SplashStretchMode">
+ The splash image covers the window without keeping the aspect ratio.
+ </constant>
<constant name="FEATURE_SHADERS" value="0" enum="Features">
Hardware supports shaders. This enum is currently unused in Godot 3.x.
</constant>