Navigation
API > API/Runtime > API/Runtime/StreamingPauseRendering
Module handling default behavior for streaming pause rendering. Games can override by calling RegisterBegin/EndStreamingPauseDelegate with their own delegates.
| Name | FStreamingPauseRenderingModule |
| Type | class |
| Header File | /Engine/Source/Runtime/StreamingPauseRendering/Public/StreamingPauseRendering.h |
| Include Path | #include "StreamingPauseRendering.h" |
Syntax
class FStreamingPauseRenderingModule : public IModuleInterface
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FStreamingPauseRenderingModule() |
Default constructor. | StreamingPauseRendering.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BackgroundView | TSharedPtr< class FBackgroundView > | Helper class to translate the RHI render target to Slate | StreamingPauseRendering.h | |
| BeginDelegate | FBeginStreamingPauseDelegate | Delegate providing default functionality for beginning streaming pause. | StreamingPauseRendering.h | |
| bMovieWasStarted | bool | If a movie was started by BeginStreamingPause. | StreamingPauseRendering.h | |
| EndDelegate | FEndStreamingPauseDelegate | Delegate providing default functionality for ending streaming pause. | StreamingPauseRendering.h | |
| SceneViewport | TSharedPtr< FSceneViewport > | Viewport being used to render the scene once to a target while paused | StreamingPauseRendering.h | |
| ViewportWidget | TSharedPtr< SViewport > | Slate viewport widget used to draw the target | StreamingPauseRendering.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginStreamingPause
(
FViewport* Viewport |
Enqueue the streaming pause to suspend rendering during blocking load. | StreamingPauseRendering.h | |
virtual void EndStreamingPause() |
Enqueue the streaming pause to resume rendering after blocking load is completed. | StreamingPauseRendering.h |
Overridden from IModuleInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ShutdownModule() |
StreamingPauseRendering.h | ||
virtual void StartupModule() |
StreamingPauseRendering.h |