update 'application/boot_splash/stretch_mode' doc

This commit is contained in:
Samuel Pedrajas 2021-10-25 21:12:09 +02:00
parent 580f7d8892
commit 210dd4fbab
2 changed files with 4 additions and 4 deletions

View file

@ -198,12 +198,12 @@
<member name="application/boot_splash/fullsize" type="bool" setter="" getter="" default="true">
If [code]true[/code], scale the boot splash image according to the mode selected in the stretch_mode property. If [code]false[/code], the engine will leave it at the default pixel size.
</member>
<member name="application/boot_splash/stretch_mode" type="String" setter="" getter="" default="keep">
Specifies how the splash image will be stretched. Takes no effect if fullsize is false. For more information about available stretch modes look for SPLASH_STRETCH_MODE* constants in the documentation.
</member>
<member name="application/boot_splash/image" type="String" setter="" getter="" default="&quot;&quot;">
Path to an image used as the boot splash.
</member>
<member name="application/boot_splash/stretch_mode" type="String" setter="" getter="" default="&quot;keep&quot;">
Specifies how the splash image will be stretched. Takes no effect if fullsize is false. For more information about available stretch modes look for SPLASH_STRETCH_MODE* constants in the documentation.
</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>

View file

@ -2575,7 +2575,7 @@
<return type="void" />
<argument index="0" name="image" type="Image" />
<argument index="1" name="color" type="Color" />
<argument index="2" name="stretch_mode" type="int" default="0" />
<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. The value of [code]stretch_mode[/code] indicates how the image will be stretched (for more information about stretch modes see SPLASH_STRETCH_MODE* constants). 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.