UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FWindowsPlatformSplash Struct Reference

#include <WindowsPlatformSplash.h>

+ Inheritance diagram for FWindowsPlatformSplash:

Static Public Member Functions

static APPLICATIONCORE_API void Show ()
 
static APPLICATIONCORE_API void Hide ()
 
static APPLICATIONCORE_API void SetProgress (int ProgressPercent)
 
static APPLICATIONCORE_API void SetSplashText (const SplashTextType::Type InType, const FText &InText)
 
static APPLICATIONCORE_API bool IsShown ()
 
static APPLICATIONCORE_API void SetSplashText (const SplashTextType::Type InType, const TCHAR *InText)
 
static void SetSplashText (const SplashTextType::Type InType, const FText &InText)
 
- Static Public Member Functions inherited from FGenericPlatformSplash
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 ()
 

Additional Inherited Members

- Static Protected Member Functions inherited from FGenericPlatformSplash
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

Windows splash implementation.

Member Function Documentation

◆ Hide()

void FWindowsPlatformSplash::Hide ( )
static

Hide the splash screen.

◆ IsShown()

bool FWindowsPlatformSplash::IsShown ( )
static

Return whether the splash screen is being shown or not

◆ SetProgress()

void FWindowsPlatformSplash::SetProgress ( int  ProgressPercent)
static

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

Parameters
InTypeProgress value in percent.

◆ SetSplashText() [1/3]

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

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

Parameters
InTypeType of text to change.
InTextText to display.

◆ SetSplashText() [2/3]

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

◆ SetSplashText() [3/3]

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

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

Parameters
InTypeType of text to change.
InTextText to display.

◆ Show()

void FWindowsPlatformSplash::Show ( )
static

Show the splash screen.


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