Navigation
API > API/Runtime > API/Runtime/SlateCore
A class which manages requests to throttle parts of the engine to ensure Slate UI performance
| Name | FSlateThrottleManager |
| Type | class |
| Header File | /Engine/Source/Runtime/SlateCore/Public/Application/ThrottleManager.h |
| Include Path | #include "Application/ThrottleManager.h" |
Syntax
class FSlateThrottleManager
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSlateThrottleManager() |
Constructor | Application/ThrottleManager.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bShouldThrottle | int32 | CVar variable to check if we allow throttling (int32 for compatibility) | Application/ThrottleManager.h | |
| CVarAllowThrottle | FAutoConsoleVariableRef | CVar allowing us to toggle throttling ability | Application/ThrottleManager.h | |
| DisableThrottleCount | int32 | If false, then throttling is explicitly disabled. | Application/ThrottleManager.h | |
| ThrottleCount | uint32 | Number of active throttle requests | Application/ThrottleManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DisableThrottle
(
bool bState |
Explicitly disable Slate throttling. | Application/ThrottleManager.h | |
FThrottleRequest EnterResponsiveMode() |
Requests that we enter responsive mode. I.E throttle slow parts of the engine | Application/ThrottleManager.h | |
bool IsAllowingExpensiveTasks() |
Whether or not we allow expensive tasks which could hurt performance to occur | Application/ThrottleManager.h | |
void LeaveResponsiveMode
(
FThrottleRequest& InHandle |
Request to leave responsive mode. | Application/ThrottleManager.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FSlateThrottleManager & Get() |
Gets the instance of this manager | Application/ThrottleManager.h |