#include <ThrottleManager.h>

Public Member Functions
SLATECORE_API	FSlateThrottleManager ()

SLATECORE_API FThrottleRequest	EnterResponsiveMode ()

SLATECORE_API void	LeaveResponsiveMode (FThrottleRequest &InHandle)

SLATECORE_API bool	IsAllowingExpensiveTasks () const

SLATECORE_API void	DisableThrottle (bool bState)

Static Public Member Functions
static SLATECORE_API FSlateThrottleManager &	Get ()

Detailed Description

A class which manages requests to throttle parts of the engine to ensure Slate UI performance

Constructor & Destructor Documentation

◆ FSlateThrottleManager()

FSlateThrottleManager::FSlateThrottleManager ( )

Constructor

Member Function Documentation

◆ DisableThrottle()

void FSlateThrottleManager::DisableThrottle ( bool bState )

Explicitly disable Slate throttling. This is intended to be used for code-driven exemptions to Slate throttling such as interactive actions that require multiple refreshes & world ticks. For single refresh scenarios, consider FEditorViewportClient.Invalidate(false, false).

Parameters

bState true if throttling should be disabled.

◆ EnterResponsiveMode()

FThrottleRequest FSlateThrottleManager::EnterResponsiveMode ( )

Requests that we enter responsive mode. I.E throttle slow parts of the engine

Returns: A handle to the request to enter responsive mode. Can only be ended with this request

◆ Get()

FSlateThrottleManager & FSlateThrottleManager::Get ( )

static

Gets the instance of this manager

◆ IsAllowingExpensiveTasks()

bool FSlateThrottleManager::IsAllowingExpensiveTasks ( ) const

Whether or not we allow expensive tasks which could hurt performance to occur

Returns: true if we allow expensive tasks, false otherwise

◆ LeaveResponsiveMode()

void FSlateThrottleManager::LeaveResponsiveMode ( FThrottleRequest & InHandle )

Request to leave responsive mode.
Note that this may not end responsive mode in the case that multiple EnterResponsiveMode requests were made