FGenericPlatformSplash

Generic implementation for most platforms

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FGenericPlatformSplash

FHoloLensSplash

References

Module

ApplicationCore

Header

/Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericPlatformSplash.h

Include

#include "GenericPlatform/GenericPlatformSplash.h"

Syntax

struct FGenericPlatformSplash

Remarks

Generic implementation for most platforms

Variables

Name Description

Protected variable

param IconFilen...

 

icon

Functions

Name Description

Protected function Static

param IconFi...

 

GetSplashPath

(
    const TCHAR* SplashFilename,
    FString& OutPath,
    bool& OutIsCustom
)

Finds a usable splash pathname for the given filename

Protected function Static

bool

 

GetSplashPath

(
    const TCHAR* SplashFilename,
    const TCHAR* IconFilename,
    FString& OutPath,
    FString& OutIconPath,
    bool& OutIsCustom
)

Finds a usable splash pathname for the given filename

Public function Static

void

 

Hide()

Hide the splash screen.

Public function Static

bool

 

IsShown()

Return whether the splash screen is being shown or not

Protected function

param IconFi...

 

name

(
    "Splash"
)

Finds a usable splash pathname for the given filename

Public function Static

void

 

SetCustomSplashImage

(
    const TCHAR* SplashFilename
)

Sets a custom splash image to display

Public function Static

void

 

SetProgress

(
    int ProgressPercent
)

Sets the progress displayed on the application icon (for startup/loading progress).

Public function Static

void

 

SetSplashText

(
    const SplashTextType::Type InType,
    const TCHAR* InText
)

Sets the text displayed on the splash screen (for startup/loading progress)

Public function Static

void

 

Show()

Show the splash screen.