Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Developer > TargetPlatform > Interfaces > ITargetPlatform

Light Theme

Dark Theme

ITargetPlatform

Interface for target platforms.

Windows

MacOS

Linux

Inheritance Hierarchy

ITargetPlatform

FTargetPlatformBase

TTargetPlatformBase

TNonDesktopTargetPlatformBase

References

Module	TargetPlatform
Header	/Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h
Include	#include "Interfaces/ITargetPlatform.h"

Syntax

class ITargetPlatform

Remarks

Interface for target platforms.

This interface provides an abstraction for cooking platforms and enumerating actual target devices.

Destructors

	Name	Description
	~ITargetPlatform()	Virtual destructor.

Functions

	Name	Description
bool	AddDevice ( const FString& DeviceName, bool bDefault )	Add a target device by name.
bool	AddDevice ( const FString& DeviceId, const FString& DeviceUserFriendlyN..., const FString& Username, const FString& Password, bool bDefault )	Add a target device.
bool	AllowsEditorObjects()	Checks whether this platform will allow editor objects to be cooked, as opposed to editoronly properties.
int32	AssignPlatformOrdinal ( const ITargetPlatform& Platform )
bool	CanSupportRemoteShaderCompile()	Checks whether this platform supports shader compilation over XGE interface.
int32	CheckRequirements ( bool bProjectHasCode, EBuildConfiguration Configuration, bool bRequiresAssetNativization, FString& OutTutorialPath, FString& OutDocumentationPath, FText& CustomizedLogMessage )	Checks whether the platform's build requirements are met so that we can do things like package for the platform.
FString	CookingDeviceProfileName()	Gets the name of the device profile to use when cooking this TargetPlatform
bool	CopyFileToTarget ( const FString& DeviceId, const FString& HostFilename, const FString& TargetFilename, const TMap< FString, FString >& Cu... )	Copy a file to the target
FText	DisplayName()	Gets the platform's display name.
void	EnableDeviceCheck ( bool OnOff )	Enables/Disable the device check
bool	ForcesSimpleSkyDiffuse()	Gets whether the platform will use SH2 instead of SH3 for sky irradiance.
bool	GenerateStreamingInstallManifest ( const TMultiMap< FString, int32 >&..., const TSet< int32 >& PakchunkIndic... )	Generates a platform specific asset manifest given an array of FAssetData.
void	GetAllDevices ( TArray< ITargetDevicePtr >& OutDev... )	Returns all discoverable physical devices.
void	GetAllPossibleShaderFormats ( TArray< FName >& OutFormats )	Gets the shader formats this platform can use.
void	GetAllTargetedShaderFormats ( TArray< FName >& OutFormats )	Gets the shader formats that have been selected for this target platform
void	GetBuildProjectSettingKeys ( FString& OutSection, TArray< FString >& InBoolKeys, TArray< FString >& InIntKeys, TArray< FString >& InStringKeys )	Project settings to check to determine if a build should occur
FConfigCache...	GetConfigSystem()	Returns the config system object usable by this TargetPlatform. It should not be modified in anyway
TSharedPtr< ...	GetCustomWidgetCreator()	Returns custom DeviceManager widget creator for this platform
ITargetDevic...	GetDefaultDevice()	Gets the default device. that not all platforms may have a notion of default devices.
ITargetDevic...	GetDevice ( const FTargetDeviceId& DeviceId )	Gets an interface to the specified device.
float	GetDownSampleMeshDistanceFieldDivider()	Gets down sample mesh distance field divider.
void	GetExtraPackagesToCook ( TArray< FName >& PackageNames )	Gets a list of package names to cook when cooking this platform
int32	GetHeightFogModeForOpaque()	Gets an integer representing the height fog mode for opaque materials on a platform.
int32	GetMemoryMappingAlignment()	Gets the alignment of memory mapping for this platform, typically the page size.
const ITarge...	GetPlatformFromOrdinal ( int32 Ordinal )	Given a platform ordinal number, returns the corresponding ITargetPlatform instance
const FDataD...	GetPlatformInfo()	Returns the information about the platform as a whole
int32	GetPlatformOrdinal()	Get unique integer identifier for this platform.
EBuildTarget...	GetRuntimePlatformType()	Return the TargetType this platform uses at runtime.
void	GetShaderCompilerDependencies ( TArray< FString >& OutDependencies )	Provide platform specific file dependency patterns for SN-DBS shader compilation.
const Platfo...	GetTargetPlatformInfo()	Returns the information about this target platform
float	GetVariantPriority()	Gets the variant priority of this platform
FName	GetZlibReplacementFormat()	Gets a new compression format to use in place of Zlib. This should be rarely implemented
bool	HasEditorOnlyData()	Checks whether this platform has only editor data (typically desktop platforms).
bool	HasSecurePackageFormat()	Checks whether this platform has a secure shippable package format, and therefore doesn't need any encryption or signing support
FString	IniPlatformName()	Gets the platform's INI name (so an offline tool can load the INI for the given target platform).
bool	InitializeHostPlatform()	Initializes the host platform to support target devices (may be called multiple times after an SDK is installed while running)
bool	IsClientOnly()	Checks whether this platform is only a client (and must connect to a server to run).
bool	IsEnabledForPlugin ( const IPlugin& Plugin )	Checks whether this platform is enabled for the given plugin in the currently active project.
bool	IsLittleEndian()	Checks whether this platform is little endian.
bool	IsRunningPlatform()	Checks whether this platform is the platform that's currently running.
bool	IsSdkInstalled ( bool bProjectHasCode, FString& OutDocumentationPath )	Checks whether the platform's SDK requirements are met so that we can do things like package for the platform
bool	IsServerOnly()	Checks whether this platform is only a server.
FOnTargetDev...	OnDeviceDiscovered()
FOnTargetDev...	OnDeviceLost()
bool	PackageBuild ( const FString& InPackgeDirectory )	Package a build for the given platform
FString	PlatformName()	Returns the name of this platform
void	RefreshSettings()	Give the platform a chance to refresh internal settings before a cook, etc
bool	RequiresCookedData()	Checks whether this platform requires cooked data (typically console platforms).
bool	RequiresTempTarget ( bool bProjectHasCode, EBuildConfiguration Configuration, bool bRequiresAssetNativization, FText& OutReason )	Checks whether the current project needs a temporary .target.cs file to be packaged as a code project.
EPlatformAut...	RequiresUserCredentials()	Checks whether this platform requires user credentials (typically server platforms).
bool	SendLowerCaseFilePaths()	Whether or not to send all lower-case filepaths when connecting over a fileserver connection.
bool	ShouldExpandTo32Bit ( const uint16* Indices, const int32 NumIndices )	Returns wheter or not this 16bit index buffer should be promoted to 32bit
bool	SupportsAutoSDK()	Returns true if the platform supports the AutoSDK system
bool	SupportsBuildTarget ( EBuildTargetType TargetType )	Checks whether this platform supports the specified build target, i.e. Game or Editor.
bool	SupportsFeature ( ETargetPlatformFeatures Feature )	Checks whether the target platform supports the specified feature.
bool	SupportsValueForType ( FName SupportedType, FName RequiredSupportedValue )	Checks whether the target platform supports the specified value for the specified type of support
bool	SupportsVariants()	Returns true if the platform is part of a family of variants
bool	UsesBasePassVelocity()	Gets whether the platform should output velocity in the base pass.
bool	UsesDBuffer()	Gets whether the platform should use DBuffer for decals.
bool	UsesDistanceFields()	Gets whether the platform will use distance fields.
bool	UsesForwardShading()	Gets whether the platform should use forward shading or not.
bool	UsesMobileAmbientOcclusion()	Gets whether the platform uses Mobile AO
bool	UsesRayTracing()	Gets whether the platform will use ray tracing.
bool	UsesSelectiveBasePassOutputs()	Gets whether the platform will use selective outputs in the base pass shaders.
bool	VelocityEncodeDepth()	Gets whether the platform will encode depth velocity.

Classes

	Name	Description
	FOnTargetDeviceDiscovered	Gets an event delegate that is executed when a new target device has been discovered.
	FOnTargetDeviceLost	Gets an event delegate that is executed when a target device has been lost, i.e. disconnected or timed out.