Unigine.Splash Class

Sort by:

List of functions:

Controls the settings of the splash screen. Demonstration of it gives Unigine the time to load all world and compile shaders. For a splash screen a two-part texture can be set.

Function that displays a texture splash screen is usually divided into two parts — intro and outro, though there can be more of them; this is achieved with the yield operator. At this point the intro part is displayed. Intro parts usually consist of two images, which are gradually blended with different coefficients to show the progress.

Example

Here's a code example on how to add your own splash screens for application and world loading.

Splash screens are defined inside the init() method of the SystemLogic class.

Source code (C#)

/* ... */ 
public override int init()
{
	// define new transform for splash screen
	vec4 transform = new vec4(1.0f, 1.0f, 0.0f, 0.0f);

	// get the splash and app instances (as they're designed as singletons)
	Splash splash = Splash.get();
	App app = App.get();

	// set transform to the system and world splash screens
	splash.setWorldTransform(transform);
	splash.setSystemTransform(transform);

	// compute the aspect ratio to show corresponding texture
	float aspect_ratio = (float)app.getWidth() / (float)app.getHeight();

	// if the aspect ratio is 4:3 show these splash screens
	// during application and world load
	if (aspect_ratio < 1.5f) {
		splash.setSystem("splash_4x3_system.png");
		splash.setWorld("splash_4x3_world.png");
	}
	else {
		// if the aspect ratio is 16:9 show these splash screens
		// during application and world load
		splash.setSystem("splash_16x9_system.png");
		splash.setWorld("splash_16x9_world.png");
	}
	return 1;
}
/* ... */

Splash Class

Members

void setColor(vec4 color)

Sets the color of the text LOADING on the black background. This text is displayed, when a splash screen being called is cleared.

Arguments

vec4 color - Text color.

void setEnabled(int enable)

Specifies if manual rendering of a splash screen (on system loading, world loading or of a custom one) can be started or should be stopped. This function is used only together with corresponding render functions (engine.splash.renderSystem(), engine.splash.renderWorld() or engine.splash.renderSplash()). This function cannot be used to enable or disable rendering of a system or a world splash screen during the initialization stage of the script.

Arguments

int enable - 1 to enable rendering of the splash screen; 0 to disable.

int isEnabled()

Returns a value indicating if manual rendering of a splash screen (on system loading, world loading or of a custom one) is allowed.

Notice

Setter function engine.splash.setEnabled() is used only together with correspondingrender functions (engine.splash.renderSystem(), engine.splash.renderWorld() orengine.splash.renderSplash()). It cannot be used to enable or disable rendering of a system or a world splash screen during the initialization stage of the script.

Return value

1 if the rendering of the splash screen was enabled; otherwise, 0.

void setSplash(string name, int threshold = 0)

Sets basic properties of a custom splash screen. This splash screen can be called from the script any time you need it. The splash screen can is a two-part texture.

Arguments

string name - Name of the file with the custom splash screen. If NULL (0) is passed, the splash screen is cleared.
int threshold - Amount of blur in the alpha channel when interpolating between states of the splash screen. This is an optional parameter; if it is not passed, 0 will be used instead.

void setSplashBackground(vec4 color)

Sets the background color of the splash screen.

Arguments

vec4 color - Background color.

void setSplashImage(Image image, int threshold = 0)

Sets an image for a custom splash screen. This splash screen can be called from the script any time you need it. The splash screen is a two-part texture shown according to the threshold.

Arguments

Image image - Image to be used as a custom splash screen.
int threshold - Amount of blur in the alpha channel when interpolating between states of the splash screen. This is an optional parameter; if it is not passed, 0 will be used instead.

void setSplashText(string str)

Sets the text of the splash screen.

Arguments

string str - Text of the splash screen.

void setSplashTransform(vec4 transform)

Sets transformation of the splash.

Arguments

vec4 transform - Transformation of the splash.

void setSystem(string name, int threshold = 0)

Sets basic properties of a system splash screen, which is displayed while resources like shaders and materials are being loaded on the engine start-up. The splash screen is a two-part texture.

NoticeIf NULL is set for a splash screen texture, LOADING text will be shown instead.

Arguments

string name - Name of the file with the system splash screen. If NULL (0) is passed, the splash screen is cleared.
int threshold - Amount of blur in the alpha channel when interpolating between states of the splash screen. This is an optional parameter; if it is not passed, 0 will be used instead.

void setSystemBackground(vec4 color)

Sets the background color of the system splash screen.

Arguments

vec4 color - Background color.

void setSystemImage(Image image, int threshold = 0)

Sets an image for a system splash screen, which is displayed while resources like shaders and materials are being loaded on the engine start-up. The splash screen is a two-part texture shown according to the threshold.

Arguments

Image image - Image to be used as a system splash screen.
int threshold - Amount of blur in the alpha channel when interpolating between states of the splash screen. This is an optional parameter; if it is not passed, 0 will be used instead.

void setSystemText(string str)

Sets the text of the system splash screen.

Arguments

string str - Text of the system splash screen.

void setSystemTransform(vec4 transform)

Sets transformation of the system splash.

Arguments

vec4 transform - Transformation of the system splash.

void setWorld(string name, int threshold = 0)

Sets basic properties of a world splash screen, which is displayed while the world is being loaded. The splash screen is a two-part texture.

NoticeIf NULL is set for a splash screen texture, LOADING text will be shown instead.

Arguments

string name - Name of the file with the world splash screen. If NULL (0) is passed, the splash screen is cleared.
int threshold - Amount of blur in the alpha channel when interpolating between states of the splash screen. This is an optional parameter; if it is not passed, 0 will be used instead.

void setWorldBackground(vec4 color)

Sets the background color of the world splash screen.

Arguments

vec4 color - Background color.

void setWorldImage(Image image, int threshold = 0)

Sets an image for a world splash screen, which is displayed while the world is being loaded. The splash screen is a two-part texture shown according to the threshold.

Arguments

Image image - Image to be used as a world splash screen.
int threshold - Amount of blur in the alpha channel when interpolating between states of the splash screen. This is an optional parameter; if it is not passed, 0 will be used instead.

void setWorldText(string str)

Sets the text of the world splash screen.

Arguments

string str - Text of the world splash screen.

void setWorldTransform(vec4 transform)

Sets transformation of the world splash.

Arguments

vec4 transform - Transformation of the world splash.

void renderInterface()

Renders a static splash screen. Such a splash screen does not display any progress.

void renderSplash(int progress)

Renders a custom splash screen in a given progress state. Use this function in a loop to create a gradual change between the initial (upper opaque part) and the final states (bottom transparent part) of the splash screen texture.

Arguments

int progress - Progress of alpha blending between 2 splash screens stored in the texture. The value in range [0;100] sets an alpha channel threshold, according to which pixels from the initial (opaque) or final (transparent) splash screen in the texture are rendered. By the value of 0, the initial screen is loaded. By the value of 100, the final screen is loaded.

void renderSystem(int progress)

Renders a splash screen image, that is displayed by the system script reload, in a given progress state. Use this function in a loop to create a gradual change between the initial (upper opaque part) and the final states (bottom transparent part) of the splash screen texture.

Arguments

int progress - Progress of alpha blending between 2 splash screens stored in the texture. The value in range [0;100] sets an alpha channel threshold, according to which pixels from the initial (opaque) or final (transparent) parts of the texture are rendered. By the value of 0, the initial screen is loaded. By the value of 100, the final screen is loaded.

void renderWorld(int progress)

Renders a splash screen image, that is displayed by the world load, in a given progress state. Use this function in a loop to create a gradual change between the initial (upper opaque part) and the final states (bottom transparent part) of the splash screen texture.

Arguments

int progress - Progress of alpha blending between 2 splash screens stored in the texture. The value in range [0;100] sets an alpha channel threshold, according to which pixels from the initial (opaque) or final (transparent) parts of the texture are rendered. By the value of 0, the initial screen is loaded. By the value of 100, the final screen is loaded.

Last update: 2018-08-10

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)