Version: 2021.3
LanguageEnglish
  • C#

SplashScreen.Stop

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

Declaration

public static void Stop(Rendering.SplashScreen.StopBehavior stopBehavior);

Description

Stop the SplashScreen rendering.

using System.Collections;
using UnityEngine;
using UnityEngine.Rendering;

// This example shows how the SplashScreen can be canceled early via the user pressing any key. public class Example : MonoBehaviour { public SplashScreen.StopBehavior stopBehavior;

void Start() { StartCoroutine(SplashScreenController()); }

IEnumerator SplashScreenController() { SplashScreen.Begin(); while (!SplashScreen.isFinished) { // Fade to the background if the user presses any key during the splash screen rendering. if (Input.anyKeyDown) { SplashScreen.Stop(stopBehavior); break; } yield return null; } } }