ITargetPlatformManagerModule

Module for the target platform manager

Windows
MacOS
Linux

Inheritance Hierarchy

IModuleInterface

ITargetPlatformManagerModule

References

Module

TargetPlatform

Header

/Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatformManagerModule.h

Include

#include "Interfaces/ITargetPlatformManagerModule.h"

Syntax

class ITargetPlatformManagerModule : public IModuleInterface

Remarks

Module for the target platform manager

Destructors

Name Description

Public function

~ITargetPlatformManagerModule()

Virtual destructor.

Functions

Name Description

Public function

const IAudio...

 

FindAudioFormat

(
    FName Name
)

Finds an audio format with the specified name.

Public function

const IPhysX...

 

FindPhysXCooking

(
    FName Name
)

Finds a PhysX format with the specified name.

Public function

const IShade...

 

FindShaderFormat

(
    FName Name
)

Finds a shader format with the specified name.

Public function

ITargetDevic...

 

FindTargetDevice

(
    const FTargetDeviceId& DeviceId
)

Finds a target device by identifier.

Public function

ITargetPlatf...

 

FindTargetPlatform

(
    FStringView Name
)

Finds a target platform by name.

Public function

ITargetPlatf...

 

FindTargetPlatform

(
    FName Name
)

Finds a target platform by name.

Public function

ITargetPlatf...

 

FindTargetPlatform

(
    const TCHAR* Name
)

Finds a target platform by name.

Public function

ITargetPlatf...

 

FindTargetPlatformWithSupport

(
    FName SupportType,
    FName RequiredSupportedValue
)

Finds a target platform by looking for one that supports a given value for a generic type of support

Public function

const ITextu...

 

FindTextureFormat

(
    FName Name
)

Finds a texture format with the specified name.

Public function

const TArray...

 

GetActiveTargetPlatforms()

Return the list of the ITargetPlatforms that we want to build data for.

Public function

const TArray...

 

GetAudioFormats()

Returns the list of all IAudioFormats that were located in DLLs.

Public function

const TArray...

 

GetCookingTargetPlatforms()

Return the list of platforms which we need to support when cooking (only set when actually cooking)

Public function

FOnTargetPla...

 

GetOnTargetPlatformsInvalidatedDelegate()

A callback that holders of ITargetPlatform* must subscribe to to be notified of when the ITargetPlatform* has been invalidated and should be requeried from e.g. FindTargetPlatform

Public function

const TArray...

 

GetPhysXCooking()

Returns the list of all IPhysXCooking that were located in DLLs.

Public function

ITargetPlatf...

 

GetRunningTargetPlatform()

Returns the target platform that is currently running.

This method is not available on consoles.

Public function

const TArray...

 

GetShaderFormats()

Returns the list of all ITextureFormats that were located in DLLs.

Public function

const TArray...

 

GetTargetPlatforms()

Returns the list of all ITargetPlatforms that were located in DLLs.

Public function

const TArray...

 

GetTextureFormats()

Returns the list of all ITextureFormats that were located in DLLs.

Public function Const

bool

 

HasInitErrors

(
    FString* OutErrorMessages
)

Determine if there were errors during the initialization of the platform manager.

Public function

void

 

Invalidate()

Invalidates the target platform module.

Public function

bool

 

RestrictFormatsToRuntimeOnly()

Checks whether we should only build formats that are actually required for use by the runtime.

Public function

uint32

 

ShaderFormatVersion

(
    FName Name
)

Gets the shader format version for the specified shader.

Public function

bool

 

UpdateAfterSDKInstall

(
    FName TargetPlatformName
)

After installing an SDK with Turnkey, this will refresh the TargetPlatform, find devices, etc

Public function

bool

 

UpdatePlatformEnvironment

(
    const FString& PlatformName,
    TArray< FString >& Keys,
    TArray< FString >& Values
)

Allows changes to environment for a given platform