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](API\Runtime\Core\Modules\IModuleInterface)  

Remarks

Module for the target platform manager

Destructors

Type Name Description
  ~ITargetPlatformManagerModule () Virtual destructor.

Functions

Type Name Description
const IAudio... FindAudioFormat ( FName Name ) Finds an audio format with the specified name.
const IPhysX... FindPhysXCooking ( FName Name ) Finds a PhysX format with the specified name.
const IShade... FindShaderFormat ( FName Name ) Finds a shader format with the specified name.
ITargetDevic... FindTargetDevice ( const FTargetDeviceId& DeviceId ) Finds a target device by identifier.
ITargetPlatf... FindTargetPlatform ( FStringView Name ) Finds a target platform by name.
ITargetPlatf... FindTargetPlatform ( FName Name ) Finds a target platform by name.
ITargetPlatf... FindTargetPlatform ( const TCHAR* Name ) Finds a target platform by name.
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
const ITextu... FindTextureFormat ( FName Name ) Finds a texture format with the specified name.
const TArray... GetActiveTargetPlatforms () Return the list of the ITargetPlatforms that we want to build data for.
const TArray... GetAudioFormats () Returns the list of all IAudioFormats that were located in DLLs.
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
const TArray... GetPhysXCooking () Returns the list of all IPhysXCooking that were located in DLLs.
ITargetPlatf... GetRunningTargetPlatform () Returns the target platform that is currently running.
const TArray... GetShaderFormats () Returns the list of all ITextureFormats that were located in DLLs.
const TArray... GetTargetPlatforms () Returns the list of all ITargetPlatforms that were located in DLLs.
const TArray... GetTextureFormats () Returns the list of all ITextureFormats that were located in DLLs.
bool HasInitErrors ( FString* OutErrorMessages ) Determine if there were errors during the initialization of the platform manager.
void Invalidate () Invalidates the target platform module.
bool RestrictFormatsToRuntimeOnly () Checks whether we should only build formats that are actually required for use by the runtime.
uint32 ShaderFormatVersion ( FName Name ) Gets the shader format version for the specified shader.
bool UpdateAfterSDKInstall ( FName TargetPlatformName ) After installing an SDK with Turnkey, this will refresh the TargetPlatform, find devices, etc
bool UpdatePlatformEnvironment ( const FString& PlatformName, TArray< FString >& Keys, TArray< FString >& Values ) Allows changes to environment for a given platform

Deprecated Functions

Type Name Description
const TArray... GetCookingTargetPlatforms () Use GetActiveTargetPlatforms instead of GetCookingTargetPlatforms

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library