FGenericPlatformSplash Struct Reference

#include <GenericPlatformSplash.h>

Inheritance diagram for FGenericPlatformSplash:

Static Public Member Functions
static void	Show ()
static void	Hide ()
static APPLICATIONCORE_API void	SetCustomSplashImage (const TCHAR *SplashFilename)
static void	SetProgress (int ProgressPercent)
static APPLICATIONCORE_API void	SetSplashText (const SplashTextType::Type InType, const TCHAR *InText)
static void	SetSplashText (const SplashTextType::Type InType, const FText &InText)
static bool	IsShown ()

Static Protected Member Functions
static APPLICATIONCORE_API bool	GetSplashPath (const TCHAR *SplashFilename, FString &OutPath, bool &OutIsCustom)
static APPLICATIONCORE_API bool	GetSplashPath (const TCHAR *SplashFilename, const TCHAR *IconFilename, FString &OutPath, FString &OutIconPath, bool &OutIsCustom)

Detailed Description

Generic implementation for most platforms

Member Function Documentation

GetSplashPath() [1/2]

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

staticprotected

GetSplashPath() [2/2]

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

staticprotected

Finds a usable splash pathname for the given filename

Parameters

SplashFilename	Name of the desired splash name("Splash")
IconFilename	Name of the desired icon name("Splash")
OutPath	String containing the path to the file, if this function returns true
OutIconPath	String containing the path to the icon, if this function returns true

Returns

true if a splash screen was found

Hide()

static void FGenericPlatformSplash::Hide ( )

inlinestatic

Hide the splash screen.

IsShown()

static bool FGenericPlatformSplash::IsShown ( )

inlinestatic

Return whether the splash screen is being shown or not

SetCustomSplashImage()

void FGenericPlatformSplash::SetCustomSplashImage ( const TCHAR *  SplashFilename )

static

Sets a custom splash image to display

Parameters

SplashFilename

Full path to the splash image to display

SetProgress()

static void FGenericPlatformSplash::SetProgress ( int  ProgressPercent )

inlinestatic

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

Parameters

InType

Progress value in percent.

SetSplashText() [1/2]

static void FGenericPlatformSplash::SetSplashText ( const SplashTextType::Type  InType, const FText &  InText  )

inlinestatic

SetSplashText() [2/2]

void FGenericPlatformSplash::SetSplashText ( const SplashTextType::Type  InType, const TCHAR *  InText  )

static

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

Parameters

InType	Type of text to change
InText	Text to display

Show()

static void FGenericPlatformSplash::Show ( )

inlinestatic

Show the splash screen.

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericPlatformSplash.h
• Engine/Source/Runtime/ApplicationCore/Private/GenericPlatform/GenericPlatformSplash.cpp