Programming
Fundamentials
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Bounds-Related Classes
Containers
Controls-Related Classes
Core Library
GUI-Related Classes
Node-Related Classes
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
Rendering-Related Classes
Utility Classes

Splash Class

Interface for splash screens rendering.This set of functions controls the settings of the splash screen. Demonstration of it gives Unigine the time to load all world and compile shaders. Splash screen is a two-part texture, gradually transitioning from the upper part to the lower one by alpha channel steps.

To use this class, include the UnigineSplash.h file.

Splash Class

Members


void setColor (const Math::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

  • const Math::vec4 & color - Text color.

void setSystemTransform (const Math::vec4 & transform)

Sets transformation of the system splash.

Arguments

  • const Math::vec4 & transform - Transformation of the system splash.

void setWorld (const char * 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. If NULL is set for a splash screen texture, LOADING text will be shown instead.

Arguments

  • const char * 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 setWorldTransform (const Math::vec4 & transform)

Sets transformation of the world splash.

Arguments

  • const Math::vec4 & transform - Transformation of the world splash.

void setSystem (const char * 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.

Arguments

  • const char * 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.

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.

Return value

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

void setSplashTransform (const Math::vec4 & transform)

Sets transformation of the splash.

Arguments

  • const Math::vec4 & transform - Transformation of the splash.

void setWorldBackground (const Math::vec4 & color)

Sets the background color of the world splash screen.

Arguments

  • const Math::vec4 & color - Color.

void setSplashText (const char * str)

Sets the text of the splash screen.

Arguments

  • const char * str - Text of the splash screen.

void setSystemImage (const Ptr<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

  • const Ptr<Image> & image - Image smart pointer to an 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 setWorldText (const char * str)

Sets the text of the world splash screen.

Arguments

  • const char * str - Text of the world splash screen

void setWorldImage (const Ptr<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

  • const Ptr<Image> & image - Image smart pointer to an 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 setSplash (const char * 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

  • const char * 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 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. If the value is 0, the initial screen is loaded. If the value is 100, the final screen is loaded.

void setSplashImage (const Ptr<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

  • const Ptr<Image> & image - Image smart pointer to an 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 setSystemBackground (const Math::vec4 & color)

Sets the background color of the system splash screen.

Arguments

  • const Math::vec4 & color - Color.

void renderInterface ()

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

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. If the value is 0, the initial screen is loaded. If the value is 100, the final screen is loaded.

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.

void setSplashBackground (const Math::vec4 & color)

Sets the background color of the splash screen.

Arguments

  • const Math::vec4 & color - Color.

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. If the value is 0, the initial screen is loaded. If the value is 100, the final screen is loaded.

void setSystemText (const char * str)

Sets the text of the system splash screen.

Arguments

  • const char * str - Text of the system splash screen.
Last update: 2017-07-03