1. Epic GamesDeveloper
  3. ITargetPlatform

ITargetPlatform

Interface for target platforms.

API > API/Developer > API/Developer/TargetPlatform > API/Developer/TargetPlatform/Interfaces

Inheritance Hierarchy

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

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function bool

AddDevice ( const FString& DeviceName,
bool bDefault
)

 Add a target device by name.
Public function bool

AddDevice ( const FString& DeviceId,
const FString& DeviceUserFriendlyName,
const FString& Username,
const FString& Password,
bool bDefault
)

 Add a target device.
Public function Const bool Checks whether this platform will allow development objects to be cooked.
Public function Const bool Checks whether this platform will allow editor objects to be cooked, as opposed to editoronly properties.
Protected function Static int32  
Public function Const bool Checks whether this platform supports shader compilation over XGE interface.
Public function Const 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.
Public function Const FString Gets the name of the device profile to use when cooking this TargetPlatform
Public function bool

CopyFileToTarget ( const FString& DeviceId,
const FString& HostFilename,
const FString& TargetFilename,
const TMap< FString, FString >& CustomPlatformData
)

 Copy a file to the target
Public function Const FText Gets the platform's display name.
Public function void

EnableDeviceCheck ( bool OnOff
)

 Enables/Disable the device check
Public function Const bool Gets whether the platform will use SH2 instead of SH3 for sky irradiance.
Public function Const bool

GenerateStreamingInstallManifest ( const TMultiMap< FString, int32 >& PakchunkMap,
const TSet< int32 >& PakchunkIndicesInUse
)

 Generates a platform specific asset manifest given an array of FAssetData.
Public function Const void Returns all discoverable physical devices.
Public function Const void Gets the shader formats this platform can use.
Public function Const void Gets the shader formats that have been selected for this target platform
Public function Const void

GetBuildProjectSettingKeys ( FString& OutSection,
TArray< FString >& InBoolKeys,
TArray< FString >& InIntKeys,
TArray< FString >& InStringKeys
)

 Project settings to check to determine if a build should occur
Public function Const FConfigCacheIni * Returns the config system object usable by this TargetPlatform. It should not be modified in anyway
Public function Const TSharedPtr< IDeviceManagerCustomPlatformWidgetCreator > Returns custom DeviceManager widget creator for this platform
Public function Const ITargetDevicePtr Gets the default device.Note that not all platforms may have a notion of default devices.
Public function ITargetDevicePtr

GetDevice ( const FTargetDeviceId& DeviceId
)

 Gets an interface to the specified device.
Public function Const float Gets down sample mesh distance field divider.
Public function Const void

GetExtraPackagesToCook ( TArray< FName >& PackageNames
)

 Gets a list of package names to cook when cooking this platform
Public function Const int32 Gets an integer representing the height fog mode for opaque materials on a platform.
Public function Const int64 Gets the alignment of memory mapping for this platform, typically the page size.
Public function Static const ITargetPlatform *

GetPlatformFromOrdinal ( int32 Ordinal
)

 Given a platform ordinal number, returns the corresponding ITargetPlatform instance
Public function Const const FDataDrivenPlatformInfo & Returns the information about the platform as a whole
Public function Const int32 Get unique integer identifier for this platform.
Public function Const void Gather per-project cook/package analytics
Public function Const void Gets the shader formats that support ray tracing for this target platform.
Public function Const EBuildTargetType Return the TargetType this platform uses at runtime.
Public function Const void

GetShaderCompilerDependencies ( TArray< FString >& OutDependencies
)

 Provide platform specific file dependency patterns for SN-DBS shader compilation.
Public function Const EOfflineBVHMode Gets static mesh offline BVH mode
Public function Const const PlatformInfo::FTargetPlatformInfo & Returns the information about this target platform
Public function Const float Gets the variant priority of this platform
Public function Const FName Gets a new compression format to use in place of Zlib. This should be rarely implemented
Public function Const bool Checks whether this platform has only editor data (typically desktop platforms).
Public function Const bool Checks whether this platform has a secure shippable package format, and therefore doesn't need any encryption or signing support
Public function Const FString Gets the platform's INI name (so an offline tool can load the INI for the given target platform).
Public function bool Initializes the host platform to support target devices (may be called multiple times after an SDK is installed while running)
Public function Const bool Checks whether this platform is only a client (and must connect to a server to run).
Public function Const bool

IsEnabledForPlugin ( const IPlugin& Plugin
)

 Checks whether this platform is enabled for the given plugin in the currently active project.
Public function Const bool Checks whether this platform is little endian.
Public function Const bool Checks whether this platform is the platform that's currently running.
Public function Const 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
Public function Const bool Checks whether this platform is only a server.
Public function Static FOnTargetDeviceDiscovered &  
Public function Static FOnTargetDeviceLost &  
Public function bool

PackageBuild ( const FString& InPackgeDirectory
)

 Package a build for the given platform
Public function Const FString Returns the name of this platform
Public function Const bool Checks whether this platform requires cooked data (typically console platforms).
Public function Const bool Checks whether this platform requires the originally released version (in addition to the previously released version) to create a patch
Public function Const 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.
Public function Const EPlatformAuthentication Checks whether this platform requires user credentials (typically server platforms).
Public function Const bool Whether or not to send all lower-case filepaths when connecting over a fileserver connection.
Public function Const bool

ShouldExpandTo32Bit ( const uint16* Indices,
const int32 NumIndices
)

 Returns wheter or not this 16bit index buffer should be promoted to 32bit
Public function Const bool Returns true if the platform supports the AutoSDK system
Public function Const bool

SupportsBuildTarget ( EBuildTargetType TargetType
)

 Checks whether this platform supports the specified build target, i.e. Game or Editor.
Public function Const bool Checks whether the target platform supports the specified feature.
Public function Const bool

SupportsValueForType ( FName SupportedType,
FName RequiredSupportedValue
)

 Checks whether the target platform supports the specified value for the specified type of support
Public function Const bool Returns true if the platform is part of a family of variants
Public function Const bool Gets whether the platform uses ASTC HDR
Public function Const bool Gets whether the platform should output velocity in the base pass.
Public function Const bool Gets whether the platform should use DBuffer for decals.
Public function Const bool Gets whether the platform will use distance fields.
Public function Const bool Gets whether the platform should use forward shading or not.
Public function Const bool Gets whether the platform uses Mobile AO
Public function Const bool Gets whether the platform will use ray tracing.
Public function Const bool Gets whether the platform will use selective outputs in the base pass shaders.
Public function Const bool Gets whether the platform will encode depth velocity.

Classes

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page