FStreamingPauseRenderingModule Class Reference

#include <StreamingPauseRendering.h>

Inheritance diagram for FStreamingPauseRenderingModule:

Public Member Functions
	FStreamingPauseRenderingModule ()
virtual void	BeginStreamingPause (class FViewport *Viewport)
virtual void	EndStreamingPause ()
virtual void	StartupModule ()
virtual void	ShutdownModule ()
Public Member Functions inherited from IModuleInterface
virtual	~IModuleInterface ()
virtual void	PreUnloadCallback ()
virtual void	PostLoadCallback ()
virtual bool	SupportsDynamicReloading ()
virtual bool	SupportsAutomaticShutdown ()
virtual bool	IsGameModule () const

Public Attributes
TSharedPtr< FSceneViewport >	SceneViewport
TSharedPtr< SViewport >	ViewportWidget
TSharedPtr< class FBackgroundView >	BackgroundView
FBeginStreamingPauseDelegate	BeginDelegate
FEndStreamingPauseDelegate	EndDelegate
bool	bMovieWasStarted

Detailed Description

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

Constructor & Destructor Documentation

FStreamingPauseRenderingModule()

FStreamingPauseRenderingModule::FStreamingPauseRenderingModule

(

)

Default constructor.

Member Function Documentation

BeginStreamingPause()

void FStreamingPauseRenderingModule::BeginStreamingPause ( class FViewport *  Viewport )

virtual

Enqueue the streaming pause to suspend rendering during blocking load.

EndStreamingPause()

void FStreamingPauseRenderingModule::EndStreamingPause ( )

virtual

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

ShutdownModule()

void FStreamingPauseRenderingModule::ShutdownModule ( )

virtual

Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finish StartupModule(). This means that, as long as a module references dependent modules in it's StartupModule(), it can safely reference those dependencies in ShutdownModule() as well.

Reimplemented from IModuleInterface.

StartupModule()

void FStreamingPauseRenderingModule::StartupModule ( )

virtual

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. ie:

FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

Reimplemented from IModuleInterface.

Member Data Documentation

BackgroundView

TSharedPtr<class FBackgroundView> FStreamingPauseRenderingModule::BackgroundView

Helper class to translate the RHI render target to Slate

BeginDelegate

FBeginStreamingPauseDelegate FStreamingPauseRenderingModule::BeginDelegate

Delegate providing default functionality for beginning streaming pause.

bMovieWasStarted

bool FStreamingPauseRenderingModule::bMovieWasStarted

If a movie was started by BeginStreamingPause.
This could be false if a movie was already playing when BeginStreamingPause was called

EndDelegate

FEndStreamingPauseDelegate FStreamingPauseRenderingModule::EndDelegate

Delegate providing default functionality for ending streaming pause.

SceneViewport

TSharedPtr<FSceneViewport> FStreamingPauseRenderingModule::SceneViewport

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

ViewportWidget

TSharedPtr<SViewport> FStreamingPauseRenderingModule::ViewportWidget

Slate viewport widget used to draw the target

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/StreamingPauseRendering/Public/StreamingPauseRendering.h
• Engine/Source/Runtime/StreamingPauseRendering/Private/StreamingPauseRendering.cpp