Language:
Discover
By Skill Level
By Category

ITargetPlatform

Choose your OS:

Inheritance Hierarchy

Syntax

class ITargetPlatform

Remarks

Interface for target platforms.

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

Destructors

Name Description

Public function Virtual

~ITargetPlatform()

Virtual destructor.

Functions

Name Description

Public function

bool

 

AddDevice

(
    const FString & DeviceName,
    bool bDefault
)

Add a target device by name.

true if the device was added, false otherwise.

Protected function Static

TARGETPLATFO...

 

AssignPlatformOrdinal

(
    const ITargetPlatform & Platform
)

Public function

bool

 

CanSupportXGEShaderCompile()

Checks whether this platform supports shader compilation over XGE interface.

Public function

int32

 

CheckRequirements

(
    const FString & ProjectPath,
    bool bProjectHasCode,
    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

FText

 

DisplayName()

Gets the platform's display name.

Public function

void

 

EnableDeviceCheck

(
    bool OnOff
)

Enables/Disable the device check

Public function

bool

 

GenerateStreamingInstallManifest

(
    const TMultiMap < FString , int32 >&...,
    const TSet < int32 >& ChunkIDsInUse
)

Generates a platform specific asset manifest given an array of FAssetData .

Public function

void

 

GetAllDevices

(
    TArray < ITargetDevicePtr >& OutDev...
)

Returns all discoverable physical devices.

Public function

ECompression ...

 

GetBaseCompressionMethod()

Gets the best generic data compressor for this platform.

Compression method.

Public function

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

int32

 

GetCompressionBitWindow()

Gets the bit window for compressor for this platform.

Compression bit window.

Public function

ITargetDevic ...

 

GetDefaultDevice()

Gets the default device.

Public function

ITargetDevic ...

 

GetDevice

(
    const FTargetDeviceId & DeviceId
)

Gets an interface to the specified device.

The target device (can be nullptr).

Public function Static

TARGETPLATFO...

 

GetPlatformFromOrdinal

(
    int32 Ordinal
)

Given a platform ordinal number, returns the corresponding ITargetPlatform instance

Public function

const Platfo ...

 

GetPlatformInfo()

Returns the information about this platform

Public function

int32

 

GetPlatformOrdinal()

Get unique integer identifier for this platform.

Public function

FText

 

GetVariantDisplayName()

Gets the variant display name of this platform.

Public function

float

 

GetVariantPriority()

Gets the variant priority of this platform

float priority for this platform variant.

Public function

FText

 

GetVariantTitle()

Gets the variant title of this platform family eg. For Android: "Texture Format"

Public function

bool

 

HasEditorOnlyData()

Checks whether this platform has only editor data (typically desktop platforms).

Public function

bool

 

HasSecurePackageFormat()

Checks whether this platform has a secure shippable package format, and therefore doesn't need any encryption or signing support

Public function

FString

 

IniPlatformName()

Gets the platform's INI name (so an offline tool can load the INI for the given target platform).

Public function

bool

 

IsClientOnly()

Checks whether this platform is only a client (and must connect to a server to run).

Public function

bool

 

IsLittleEndian()

Checks whether this platform is little endian.

Public function

bool

 

IsRunningPlatform()

Checks whether this platform is the platform that's currently running.

Public function

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

bool

 

IsServerOnly()

Checks whether this platform is only a server.

Public function

FOnTargetDev ...

 

OnDeviceDiscovered()

Public function

FOnTargetDev ...

 

OnDeviceLost()

Public function

bool

 

PackageBuild

(
    const FString & InPackgeDirectory
)

Package a build for the given platform

bool true on success, false otherwise.

Public function

FString

 

PlatformName()

Returns the name of this platform

Platform name.

Public function

void

 

RefreshSettings()

Give the platform a chance to refresh internal settings before a cook, etc

Public function

bool

 

RequiresCookedData()

Checks whether this platform requires cooked data (typically console platforms).

Public function

bool

 

RequiresUserCredentials()

Checks whether this platform requires user credentials (typically server platforms).

Public function

bool

 

SendLowerCaseFilePaths()

Whether or not to send all lower-case filepaths when connecting over a fileserver connection.

Public function

bool

 

SupportsAutoSDK()

Returns true if the platform supports the AutoSDK system

Public function

bool

 

SupportsBuildTarget

(
    EBuildTargets::Type BuildTarget
)

Checks whether this platform supports the specified build target, i.e. Game or Editor.

Public function

bool

 

SupportsFeature

(
    ETargetPlatformFeatures Feature
)

Checks whether the target platform supports the specified feature.

Public function

bool

 

SupportsVariants()

Returns true if the platform is part of a family of variants

Public function

bool

 

UsesDBuffer()

Gets whether the platform should use DBuffer for decals.

Public function

bool

 

UsesForwardShading()

Gets whether the platform should use forward shading or not.

Classes

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.

References

Module

TargetPlatform

Header

Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h