1. Epic GamesDeveloper
  3. ITargetPlatformManagerModule

ITargetPlatformManagerModule

Module for the target platform manager

Unreal Engine C++ API Reference > Developer > TargetPlatform > Interfaces

Inheritance Hierarchy

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

  Type Name Description
Public function   Virtual destructor.

Functions

  Type Name Description
Public function const IAudioFormat * Finds an audio format with the specified name.
Public function const IPhysXCooking * Finds a PhysX format with the specified name.
Public function const IShaderFormat * Finds a shader format with the specified name.
Public function ITargetDevicePtr

FindTargetDevice ( const FTargetDeviceId& DeviceId
)

 Finds a target device by identifier.
Public function ITargetPlatform *

FindTargetPlatform ( FStringView Name
)

 Finds a target platform by name.
Public function ITargetPlatform * Finds a target platform by name.
Public function ITargetPlatform *

FindTargetPlatform ( const TCHAR* Name
)

 Finds a target platform by name.
Public function ITargetPlatform *

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 ITextureFormat * Finds a texture format with the specified name.
Public function const TArray< ITargetPlatform * > & Return the list of the ITargetPlatforms that we want to build data for.
Public function const TArray< const class IAudioFormat * > & Returns the list of all IAudioFormats that were located in DLLs.
Public function FOnTargetPlatformsInvalidated & 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< const class IPhysXCooking * > & Returns the list of all IPhysXCooking that were located in DLLs.
Public function ITargetPlatform * Returns the target platform that is currently running.
Public function const TArray< const class IShaderFormat * > & Returns the list of all ITextureFormats that were located in DLLs.
Public function const TArray< ITargetPlatform * > & Returns the list of all ITargetPlatforms that were located in DLLs.
Public function const TArray< const class ITextureFormat * > & 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 Invalidates the target platform module.
Public function bool Checks whether we should only build formats that are actually required for use by the runtime.
Public function uint32 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

Deprecated Functions

  Type Name Description
Public function const TArray< ITargetPlatform * > & Use GetActiveTargetPlatforms instead of GetCookingTargetPlatforms

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page