Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

SplashScreen.Begin

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

public static function Begin(): void;
public static void Begin();

Description

Initializes the splash screen so it is ready to begin drawing. Call this before you start calling SplashScreen.Draw. Internally this function resets the timer and prepares the logos for drawing.

#pragma strict
// This example shows how you could draw the splash screen at the start of a scene. This is a good way to integrate the splash screen with your own or add extras such as Audio.
public class SplashScreenExample extends MonoBehaviour {
	function Start() {
		Debug.Log("Showing splash screen");
		SplashScreen.Begin();
		while ( !SplashScreen.isFinished ) {
			SplashScreen.Draw();
			null}
		Debug.Log("Finished showing splash screen");
	}
}
using System.Collections;
using UnityEngine;
using UnityEngine.Rendering;

// This example shows how you could draw the splash screen at the start of a scene. This is a good way to integrate the splash screen with your own or add extras such as Audio. public class SplashScreenExample : MonoBehaviour { IEnumerator Start() { Debug.Log("Showing splash screen"); SplashScreen.Begin(); while (!SplashScreen.isFinished) { SplashScreen.Draw(); yield return null; } Debug.Log("Finished showing splash screen"); } }