Navigation
Unreal Engine C++ API Reference > Runtime > PreLoadScreen
References
Module | PreLoadScreen |
Header | /Engine/Source/Runtime/PreLoadScreen/Public/PreLoadScreenManager.h |
Include | #include "PreLoadScreenManager.h" |
Syntax
class FPreLoadScreenManager
Remarks
Class that handles storing all registered PreLoadScreens and Playing/Stopping them.
Variables
Type | Name | Description | |
---|---|---|---|
![]() |
int32 | ActivePreLoadScreenIndex | |
![]() |
bool | bHasRenderPreLoadScreenFrame_RenderThread | |
![]() |
bool | bInitialized | |
![]() |
bool | bIsEngineLoadingComplete | |
![]() |
bool | bIsResponsibleForRendering | |
![]() |
friend | FPreLoadScreenSlateSynchMechanism | |
![]() |
FIsPreloadScreenResponsibleForRenderingMultiDelegate | IsResponsibleForRenderingDelegate | |
![]() |
double | LastRenderTickTime | |
![]() |
double | LastTickTime | |
![]() |
TWeakPtr< class SWindow > | MainWindow | The window that the loading screen resides in |
![]() |
FOnPreLoadScreenManagerCleanUp | OnPreLoadScreenManagerCleanUp | |
![]() |
float | OriginalSlateSleepVariableValue | |
![]() |
TArray< TSharedPtr< IPreLoadScreen > > | PreLoadScreens | |
![]() |
FPreLoadScreenSlateSynchMechanism * | SyncMechanism | The threading mechanism with which we handle running slate on another thread |
![]() |
TSharedPtr< class SVirtualWindow > | VirtualRenderWindow | Virtual window that we render to instead of the main slate window (for thread safety). |
![]() |
TSharedPtr< FPreLoadSlateWidgetRenderer > | WidgetRenderer | Widget renderer used to tick and paint windows in a thread safe way |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
Default constructor. We don't want other classes to make these. Should just rely on Get() |
Destructors
Type | Name | Description | |
---|---|---|---|
![]() |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
bool | ||
![]() |
void | BeginPlay () |
|
![]() |
void | ||
![]() ![]() |
void | Create () |
|
![]() ![]() |
void | Destroy () |
|
![]() |
void | Separate tick that handles. | |
![]() |
void | ||
![]() ![]() |
void | EnableRendering
(
bool bEnabled |
|
![]() |
void | ||
![]() ![]() |
FPreLoadScreenManager * | Get () |
Gets the single instance of this settings object. Also creates it if needed. |
![]() |
IPreLoadScreen * | ||
![]() ![]() |
const IPreLoadScreen * | ||
![]() |
TSharedPtr< SWindow > | ||
![]() |
void | ||
![]() |
void | ||
![]() |
void | ||
![]() |
void | ||
![]() ![]() |
bool | HasActivePreLoadScreenType
(
EPreLoadScreenTypes PreLoadScreenTypeToCheck |
|
![]() ![]() |
bool | ||
![]() ![]() |
bool | HasRegisteredPreLoadScreenType
(
EPreLoadScreenTypes PreLoadScreenTypeToCheck |
|
![]() ![]() |
bool | ||
![]() |
void | Initialize
(
FSlateRenderer& InSlateRenderer |
|
![]() ![]() |
bool | ||
![]() ![]() |
bool | ||
![]() ![]() |
void | ||
![]() |
void | ||
![]() |
bool | PlayFirstPreLoadScreen
(
EPreLoadScreenTypes PreLoadScreenTypeToPlay |
Plays the first found PreLoadScreen that matches the bEarlyPreLoadScreen setting passed in. |
![]() |
void | PlayPreLoadScreenAtIndex
(
int32 Index |
|
![]() |
bool | PlayPreLoadScreenWithTag
(
FName InTag |
Plays the PreLoadScreen with a tag that matches InTag |
![]() |
void | RegisterPreLoadScreen
(
const TSharedPtr< IPreLoadScreen >& PreLoadScreen |
|
![]() |
void | ||
![]() |
void | SetEngineLoadingComplete
(
bool IsEngineLoadingFinished |
|
![]() ![]() |
void | Creates a tick on the Render Thread that we run every. | |
![]() |
void | ||
![]() |
void | UnRegisterPreLoadScreen
(
const TSharedPtr< IPreLoadScreen >& PreLoadScreen |
|
![]() |
void |
Classes
Type | Name | Description | |
---|---|---|---|
![]() |
FPreLoadScreenManagerDelete | Singleton Instance. |
Typedefs
Name | Description |
---|---|
FIsPreloadScreenResponsibleForRenderingMultiDelegate | |
FOnPreLoadScreenManagerCleanUp | Callback for handling cleaning up any resources you would like to remove after the PreLoadScreenManager cleans up Not needed for PreLoadScreens as those have a separate CleanUp method called. |
Constants
Name | Description |
---|---|
ActivePreloadScreen | |
ActivePreloadScreenCriticalSection | |
bRenderingEnabled | |
Instance |