IPIEPreviewDeviceModule Class Reference

#include <IPIEPreviewDeviceModule.h>

Inheritance diagram for IPIEPreviewDeviceModule:

Public Member Functions
virtual const FString	GetRuntimeDeviceProfileName () override
virtual void	StartupModule () override
virtual void	ShutdownModule () override
virtual	~IPIEPreviewDeviceModule ()
virtual FName	GetPreviewPlatformName ()=0
virtual TSharedRef< SWindow >	CreatePIEPreviewDeviceWindow (FVector2D ClientSize, FText WindowTitle, EAutoCenter AutoCenterType, FVector2D ScreenPosition, TOptional< float > MaxWindowWidth, TOptional< float > MaxWindowHeight)=0
virtual void	OnWindowReady (TSharedRef< SWindow > Window)
virtual void	ApplyPreviewDeviceState ()=0
virtual void	SetGameLayerManagerWidget (TSharedPtr< class SGameLayerManager > GameLayerManager)
virtual void	SetPreviewDevice (const FString &DeviceName)=0
Public Member Functions inherited from IDeviceProfileSelectorModule
	IDeviceProfileSelectorModule ()
virtual const FString	GetDeviceProfileName ()
virtual void	SetSelectorProperties (const TMap< FName, FString > &SelectorProperties)
virtual bool	GetSelectorPropertyValue (const FName &PropertyType, FString &PropertyValueOUT)
virtual	~IDeviceProfileSelectorModule ()
Public Member Functions inherited from IModuleInterface
virtual	~IModuleInterface ()
virtual void	PreUnloadCallback ()
virtual void	PostLoadCallback ()
virtual bool	SupportsDynamicReloading ()
virtual bool	SupportsAutomaticShutdown ()
virtual bool	IsGameModule () const

Additional Inherited Members
Protected Attributes inherited from IDeviceProfileSelectorModule
float	ConstrainedAspectRatio
FVector4f	SafeZones

Constructor & Destructor Documentation

~IPIEPreviewDeviceModule()

virtual IPIEPreviewDeviceModule::~IPIEPreviewDeviceModule ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

ApplyPreviewDeviceState()

virtual void IPIEPreviewDeviceModule::ApplyPreviewDeviceState ( )

pure virtual

Apply PieWindow device parameters

CreatePIEPreviewDeviceWindow()

virtual TSharedRef< SWindow > IPIEPreviewDeviceModule::CreatePIEPreviewDeviceWindow ( FVector2D  ClientSize, FText  WindowTitle, EAutoCenter  AutoCenterType, FVector2D  ScreenPosition, TOptional< float >  MaxWindowWidth, TOptional< float >  MaxWindowHeight  )

pure virtual

Create PieWindow Ref

GetPreviewPlatformName()

virtual FName IPIEPreviewDeviceModule::GetPreviewPlatformName ( )

pure virtual

Used to set the scalability preview platform

GetRuntimeDeviceProfileName()

virtual const FString IPIEPreviewDeviceModule::GetRuntimeDeviceProfileName ( )

overridevirtual

Run the logic to choose an appropriate device profile for this session

Returns

The name of the device profile to use for this session

Implements IDeviceProfileSelectorModule.

OnWindowReady()

virtual void IPIEPreviewDeviceModule::OnWindowReady ( TSharedRef< SWindow >  Window )

inlinevirtual

should be called after the window is created and registered and before scene rendering begins

SetGameLayerManagerWidget()

virtual void IPIEPreviewDeviceModule::SetGameLayerManagerWidget ( TSharedPtr< class SGameLayerManager >  GameLayerManager )

inlinevirtual

we need the game layer manager to control the DPI scaling behavior and this function can be called should be called when the manager is available

SetPreviewDevice()

virtual void IPIEPreviewDeviceModule::SetPreviewDevice ( const FString &  DeviceName )

pure virtual

ShutdownModule()

virtual void IPIEPreviewDeviceModule::ShutdownModule ( )

overridevirtual

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()

virtual void IPIEPreviewDeviceModule::StartupModule ( )

overridevirtual

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.

---

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

• Engine/Source/Runtime/Engine/Public/IPIEPreviewDeviceModule.h