Version: 2022.2
LanguageEnglish
  • C#

SplashScreen

class in UnityEditor

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

Interface to splash screen player settings.

Static Properties

animationBackgroundZoomThe target zoom (from 0 to 1) for the background when it reaches the end of the SplashScreen animation's total duration. Only used when animationMode is AnimationMode.Custom.
animationLogoZoomThe target zoom (from 0 to 1) for the logo when it reaches the end of the logo animation's total duration. Only used when animationMode is AnimationMode.Custom.
animationModeThe type of animation applied during the splash screen.
backgroundThe background Sprite that is shown in landscape mode. Also shown in portrait mode if backgroundPortrait is null.
backgroundColorThe background color shown if no background Sprite is assigned. Default is a dark blue RGB(34.44,54).
backgroundPortraitThe background Sprite that is shown in portrait mode.
blurBackgroundImageDetermines whether Unity applies a blur effect to the background Sprite on the Splash Screen.
drawModeDetermines how the Unity logo should be drawn, if it is enabled. If no Unity logo exists in [logos] then the draw mode defaults to DrawMode.UnityLogoBelow.
logosThe collection of logos that is shown during the splash screen. Logos are drawn in ascending order, starting from index 0, followed by 1, etc etc.
overlayOpacityIn order to increase contrast between the background and the logos, an overlay color modifier is applied. The overlay opacity is the strength of this effect. Note: Reducing the value below 0.5 requires a Plus/Pro license.
showSet this to true to display the Splash Screen be shown when the application is launched. Set it to false to disable the Splash Screen. Note: Disabling the Splash Screen requires a Plus/Pro license.
showUnityLogoSet this to true to show the Unity logo during the Splash Screen. Set it to false to disable the Unity logo. Note: Disabling the Unity logo requires a Plus/Pro license.
unityLogoStyleThe style to use for the Unity logo during the Splash Screen.