Version: 2022.3
LanguageEnglish
  • C#

PlayerSettings.iOS.SetLaunchScreenImage

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

Declaration

public static void SetLaunchScreenImage(Texture2D image, iOSLaunchScreenImageType type);

Description

Sets the image to display on screen when the game launches for the specified iOS device.

This function adds the specified image to the launch screen's Interface Builder (.xib) file in the generated iOS Xcode project. The image is only used by iOSLaunchScreenType.ImageAndBackgroundConstant and iOSLaunchScreenType.ImageAndBackgroundRelative. Use the PlayerSettings.iOS.SetiPhoneLaunchScreenType or PlayerSettings.iOS.SetiPadLaunchScreenType functions to set the launch screen type for your target device.