FStreamingPauseRenderingModule

Module handling default behavior for streaming pause rendering.

Windows
MacOS
Linux

Inheritance Hierarchy

IModuleInterface

FStreamingPauseRenderingModule

References

Module

StreamingPauseRendering

Header

/Engine/Source/Runtime/StreamingPauseRendering/Public/StreamingPauseRendering.h

Include

#include "StreamingPauseRendering.h"

Syntax

class FStreamingPauseRenderingModule : public IModuleInterface

Remarks

Module handling default behavior for streaming pause rendering. Games can override by calling RegisterBegin/EndStreamingPauseDelegate with their own delegates.

Variables

Name Description

Public variable

TSharedPtr< cla...

 

BackgroundView

Helper class to translate the RHI render target to Slate

Public variable

FBeginStreaming...

 

BeginDelegate

Delegate providing default functionality for beginning streaming pause.

Public variable

bool

 

bMovieWasStarted

If a movie was started by BeginStreamingPause.

Public variable

FEndStreamingPa...

 

EndDelegate

Delegate providing default functionality for ending streaming pause.

Public variable

TSharedPtr< FSc...

 

SceneViewport

Viewport being used to render the scene once to a target while paused

Public variable

TSharedPtr< SVi...

 

ViewportWidget

Slate viewport widget used to draw the target

Constructors

Name Description

Public function

FStreamingPauseRenderingModule()

Default constructor.

Functions

Name Description

Public function Virtual

void

 

BeginStreamingPause

(
    FViewport* Viewport
)

Enqueue the streaming pause to suspend rendering during blocking load.

Public function Virtual

void

 

EndStreamingPause()

Enqueue the streaming pause to resume rendering after blocking load is completed.

Overridden from IModuleInterface

Name Description

Public function Virtual

void

 

ShutdownModule()

Called before the module is unloaded, right before the module object is destroyed.

Public function Virtual

void

 

StartupModule()

Called right after the module DLL has been loaded and the module object has been created Load dependent modules here, and they will be guaranteed to be available during ShutdownModule.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss