FPIEPreviewDeviceModule

Implements the Preview Device Profile Selector module.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

PIEPreviewDeviceProfileSelector

Header

/Engine/Source/Editor/PIEPreviewDeviceProfileSelector/Public/PIEPreviewDeviceProfileSelectorModule.h

Include

#include "PIEPreviewDeviceProfileSelectorModule.h"

Syntax

class FPIEPreviewDeviceModule : public IPIEPreviewDeviceModule

Remarks

Implements the Preview Device Profile Selector module.

Variables

Constructors

Name Description

Public function

FPIEPreviewDeviceModule()

Destructors

Name Description

Public function Virtual

~FPIEPreviewDeviceModule()

Virtual destructor.

Functions

Overridden from IPIEPreviewDeviceModule

Name Description

Public function Virtual

void

 

ApplyCommandLineOverrides()

Gives the PIEPreviewDeviceModule a chance to modify the command line based on the target device json

Public function Virtual

void

 

ApplyPreviewDeviceState()

Apply PieWindow device parameters

Public function Virtual

TSharedRef< ...

 

CreatePIEPreviewDeviceWindow

(
    FVector2D ClientSize,
    FText WindowTitle,
    EAutoCenter AutoCenterType,
    FVector2D ScreenPosition,
    TOptional< float > MaxWindowWidth,
    TOptional< float > MaxWindowHeight
)

Create PieWindow Ref

Public function Virtual

void

 

OnWindowReady

(
    TSharedRef< SWindow > Window
)

Call this after the window is created and registered to the application to setup display related parameters

Public function Virtual

void

 

SetGameLayerManagerWidget

(
    TSharedPtr< class SGameLayerManager...
)

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

Public function Virtual

void

 

SetPreviewDevice

(
    const FString& DeviceName
)

Overridden from IDeviceProfileSelectorModule

Name Description

Public function Virtual

const FStrin...

 

GetRuntimeDeviceProfileName()

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

Public function Virtual

bool

 

GetSelectorPropertyValue

(
    const FName& PropertyType,
    FString& PropertyValueOUT
)

Find a custom profile selector property value.

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.

Typedefs

Name

Description

FAddToDevicePreviewMenu