Overview#

The Simple Splash Screen extension provides an easy way to display a splash image during early application startup. It is designed to load as early as possible so that users see a branded splash screen immediately. The extension exposes public APIs for managing the splash screen display without requiring complex setup.

Concepts#

The extension exposes two key APIs: ISplashScreen and SplashScreen.
ISplashScreen defines the interface for splash screen management while SplashScreen provides a basic implementation.
The splash screen appears during startup to provide visual feedback while the rest of the application initializes.

Functionality#

The splash screen shows a designated image, providing a clean visual during application launch.
Developers can interact with the splash screen using the provided APIs to show, hide, or acquire the current splash screen interface.
The extension is optimized to load very early in the process, ensuring immediate visibility.

Configuration#

The splash image is configurable via the extension settings. In the extension.toml, the setting:
ext. “omni.kit.window.splash”.imagePath = “${resources}/splash/splash.png”
specifies the path to the image asset used for the splash screen.

Relationships#

This extension depends on the omni.assets.plugins module, ensuring that asset management features are available for loading the splash image.
The early load order (order = -5000) ensures the splash screen is available almost immediately at startup.

Considerations#

The extension is intended for simple splash screen needs; customization is primarily through the provided public APIs and imagePath setting.
As it focuses on early-stage display, it is optimized for minimal overhead and quick initialization rather than extensive runtime interactions.