description:
Find an item from the history with the specified revision.
a history item or NULL if the item could not be found

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlRevision](API\Developer\SourceControl\ISourceControlRevision), ESPMode::ThreadSafe > FindHistoryRevision ( const [FString](API\Runtime\Core\Containers\FString) & InRevision ) const


module: SourceControl

code: operator bool&40;&41; const


className: FResolveInfo

code: struct FResolveInfo

BaseFile

type: FString


description:
Get the revision that we should use as a base when performing a three way merge, does not refresh source control state
a revision identifier or NULL if none exist

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlRevision](API\Developer\SourceControl\ISourceControlRevision), ESPMode::ThreadSafe > GetBaseRevForMerge() const


description: Get the other branches this file is checked out in

code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetCheckedOutBranches() const


description:
Get the revision that we are currently synced to
a revision identifier or NULL if none exist

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlRevision](API\Developer\SourceControl\ISourceControlRevision), ESPMode::ThreadSafe > GetCurrentRevision() const


description:
Get a text representation of the state
the text to display for this state


description:
Get a tooltip to describe this state
the text to display for this states tooltip


description:
Get the local filename that this state represents
the filename

code: const [FString](API\Runtime\Core\Containers\FString) & GetFilename() const


description:
Get an item from the history
a history item or NULL if none exist

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlRevision](API\Developer\SourceControl\ISourceControlRevision), ESPMode::ThreadSafe > GetHistoryItem ( int32 HistoryIndex ) const


description:
Get the size of the history. If anFUpdateStatusoperation has been called with the ShouldUpdateHistory() set, there should be history present if the file has been committed to source control.
the number of items in the history

code: int32 GetHistorySize() const


description: Gets the icon we should use to display the state in a UI.


description:
Get the name of the icon graphic we should use to display the state in a UI.
the name of the icon to display

code: virtual [FName](API\Runtime\Core\UObject\FName) GetIconName() const


description:
Get head modification information for other branches
true with parameters populated if there is a branch with a newer modification (edit/delete/etc)

code: bool GetOtherBranchHeadModification ( [FString](API\Runtime\Core\Containers\FString) & HeadBranchOut, [FString](API\Runtime\Core\Containers\FString) & ActionOut, int32 & HeadChangeListOut ) const


description: Get the user info for checkouts on other branches


description:
Get the file and revision number of the base and remote assets considered in a merge resolve
a validFResolveInfoif the asset is being resolved, otherwiseFResolveInfo::IsValid()will return false

code: virtual [FResolveInfo](API\Developer\SourceControl\ISourceControlState\FResolveInfo) GetResolveInfo() const


description:
Get the name of the small icon graphic we should use to display the state in a UI.
the name of the icon to display

code: virtual [FName](API\Runtime\Core\UObject\FName) GetSmallIconName() const


description: Gets the status message associated with this state, if any. This is a superset of the GetWarningText that also includes IsCheckedOut.

code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FText](API\Runtime\Core\Internationalization\FText) > GetStatusText() const


description:
Get the timestamp of the last update that was made to this state.
the timestamp of the last update

code: const [FDateTime](API\Runtime\Core\Misc\FDateTime) & GetTimeStamp() const


description: Gets the warnings messages associated with this state, if any. Ex 'checkout by other', 'out of date', etc).

code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FText](API\Runtime\Core\Internationalization\FText) > GetWarningText() const


code: enum { INVALID_REVISION = -1 }


description: Get whether this file is marked for add

code: bool IsAdded() const


description: Get whether this file is checked out by the current user

code: bool IsCheckedOut() const


description: Get whether this file is checked out in a different branch, if no branch is specified defaults to FEngineVerion current branch

code: bool IsCheckedOutInOtherBranch ( const [FString](API\Runtime\Core\Containers\FString) & CurrentBranch ) const


description: Get whether this file is checked out or modified in a different branch, if no branch is specified defaults to FEngineVerion current branch

code: bool IsCheckedOutOrModifiedInOtherBranch ( const [FString](API\Runtime\Core\Containers\FString) & CurrentBranch ) const


description: Get whether this file is checked out by someone else in the current branch

code: bool IsCheckedOutOther ( [FString](API\Runtime\Core\Containers\FString) * Who ) const


description: Get whether this file is in a conflicted state

code: virtual bool IsConflicted() const


description: Get whether this file is up-to-date with the version in source control

code: bool IsCurrent() const


description: Get whether this file is marked for delete

code: bool IsDeleted() const


description: Get whether this file is ignored by source control

code: bool IsIgnored() const


description: Get whether this file is local to the current user (ie, has never been pushed to anyone else)

code: virtual bool IsLocal() const


description: Get whether this file is modified compared to the version we have from source control

code: bool IsModified() const


description: Get whether this file is modified in a different branch, if no branch is specified defaults to FEngineVerion current branch

code: bool IsModifiedInOtherBranch ( const [FString](API\Runtime\Core\Containers\FString) & CurrentBranch ) const


description: Get whether this file is under source control

code: bool IsSourceControlled() const


description: Get whether we know anything about this files source control state

code: bool IsUnknown() const


description: Virtual destructor

code: virtual ~ISourceControlState()


className: ISourceControlState

description: An abstraction of the state of a file under source control

code: class ISourceControlState : public [TSharedFromThis< ISourceControlState, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


className: operator!

code: constexpr bool operator! ( [FSourceControlResultInfo::EAdditionalErrorContext](API\Developer\SourceControl\FSourceControlResultInfo\EAdditionalErrorContext) E )


description: The name used to identity this style set

code: virtual const [FName](API\Runtime\Core\UObject\FName) & GetStyleSetName() const


code: FDefaultRevisionControlStyle()


code: virtual ~FDefaultRevisionControlStyle()


className: FDefaultRevisionControlStyle

description: The default revision control style the editor ships with. Inherit from this to create a custom revision controls style UseFRevisionControlStyleManager::SetActiveRevisionControlStyleto change the currently active revision control style Edit the defaults in the constructor here to change any revision control icons in the editor

code: class FDefaultRevisionControlStyle : public [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet)

BranchedColor

type: FLinearColor

description: The specific color we use for all the "Branched" icons


className: CurrentRevisionControlStyleName

description: The currently active revision control style.


className: DefaultRevisionControlStyleInstance

description: The default revision control style instance.

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) > DefaultRevisionControlStyleInstance = nullptr;


description: The name of the current revision control style being used


description: The current revision control style being used

code: static const [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) & Get()


description: Reloads textures used by slate renderer

code: static void ReloadTextures()


description: Set the active revision control style to the default style


description: Set the active revision control style to the input style name

code: static void SetActiveRevisionControlStyle ( [FName](API\Runtime\Core\UObject\FName) InNewActiveRevisionControlStyleName )


className: FRevisionControlStyleManager

description: The style manager that is used to access the currently active revision control style. UseFRevisionControlStyleManager::Get()to access and use any revision control icons/styles

code: class FRevisionControlStyleManager


className: SourceControlHelpers

description: For backwards compatibility.

code: typedef class [USourceControlHelpers](API\Developer\SourceControl\USourceControlHelpers) SourceControlHelpers


code: const [FString](API\Runtime\Core\Containers\FString) & GetParameter() const


code: void SourceControlOperationComplete ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & Operation, [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) InResult )


code: FAsyncCommandHelper ( const [FString](API\Runtime\Core\Containers\FString) & InParameter )


className: FAsyncCommandHelper

description: Helper class for receiving the results of async source control operations

code: class FAsyncCommandHelper


description:
Helper function to convert a filename array to absolute paths.
an array of filenames, transformed into absolute paths

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > AbsoluteFilenames ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFileNames )


description:
Helper function to annotate a file using a label
true if successful

code: static bool AnnotateFile ( [ISourceControlProvider](API\Developer\SourceControl\ISourceControlProvider) & InProvider, const [FString](API\Runtime\Core\Containers\FString) & InLabel, const [FString](API\Runtime\Core\Containers\FString) & InFile, [TArray](API\Runtime\Core\Containers\TArray)< [FAnnotationLine](API\Developer\SourceControl\FAnnotationLine) > & OutLines )


description:
Helper function to annotate a file using a changelist/checkin identifier
true if successful

code: static bool AnnotateFile ( [ISourceControlProvider](API\Developer\SourceControl\ISourceControlProvider) & InProvider, int32 InCheckInIdentifier, const [FString](API\Runtime\Core\Containers\FString) & InFile, [TArray](API\Runtime\Core\Containers\TArray)< [FAnnotationLine](API\Developer\SourceControl\FAnnotationLine) > & OutLines )


description:
Applies the provided function and optionally reloads the world
true if succeeded.

code: static bool ApplyOperationAndReloadPackages ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InPackagesToApplyOperation, const [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > &)> & InOperation, bool bReloadWorld, bool bInteractive )


description: Query the source control state of the specified file, asynchronously.

code: static void AsyncQueryFileState ( [FQueryFileStateDelegate](API\Developer\SourceControl\USourceControlHelpers\FQueryFileStateDelegate) FileStateCallback, const [FString](API\Runtime\Core\Containers\FString) & InFile, bool bSilent )


description:
Helper function to branch/integrate packages from one location to another maintaining a relationship between the files in source control (when possible)
true if the file packages were successfully branched.

code: static bool BranchPackage ( [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * DestPackage, [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * SourcePackage, [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) StateCacheUsage )


description:
Blocks until action is complete.
true if succeeded, false if failed and can callLastErrorMsg()for more info.

code: static bool CheckInFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, const [FString](API\Runtime\Core\Containers\FString) & InDescription, bool bSilent, bool bKeepCheckedOut )


code: static bool CheckInFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, const [FString](API\Runtime\Core\Containers\FString) & InDescription, bool bSilent, bool bKeepCheckedOut )


code: static bool CheckOutFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, bool bSilent )


code: static bool CheckOutFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, bool bSilent )


code: static bool CheckOutOrAddFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, bool bSilent )


code: static bool CheckOutOrAddFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, bool bSilent )


description: CheckOutOrAddFile()

code: static bool CheckoutOrMarkForAdd ( const [FString](API\Runtime\Core\Containers\FString) & InDestFile, const [FText](API\Runtime\Core\Internationalization\FText) & InFileDescription, const [FOnPostCheckOut](API\Developer\SourceControl\FOnPostCheckOut) & OnPostCheckOut, [FText](API\Runtime\Core\Internationalization\FText) & OutFailReason )


code: static bool CopyFile ( const [FString](API\Runtime\Core\Containers\FString) & InSourceFile, const [FString](API\Runtime\Core\Containers\FString) & InDestFile, bool bSilent )


description:
Blocks until action is complete. Older C++ only version ofCopyFile().
Success or failure of the operation

code: static bool CopyFileUnderSourceControl ( const [FString](API\Runtime\Core\Containers\FString) & InDestFile, const [FString](API\Runtime\Core\Containers\FString) & InSourceFile, const [FText](API\Runtime\Core\Internationalization\FText) & InFileDescription, [FText](API\Runtime\Core\Internationalization\FText) & OutFailReason )


description:
Helper function to copy a package from one location to another
true if the file packages were successfully branched.

code: static bool CopyPackage ( [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * DestPackage, [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * SourcePackage, [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) StateCacheUsage )


description:
Determine the name of the current source control provider.
the name of the current source control provider. If one is not set then "None" is returned.


className: FQueryFileStateDelegate

description: Delegate to broadcast FileState upon AsyncQueryFileState completion.

code: class FQueryFileStateDelegate


description:
Helper function to retrieve theFAssetDataassociated with a given file
Whether the asset data could be retrieved or not

code: static bool GetAssetData ( const [FString](API\Runtime\Core\Containers\FString) & InFileName, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssets, [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > * OutDependencies )


code: static bool GetAssetData ( const [FString](API\Runtime\Core\Containers\FString) & InFileName, const [FString](API\Runtime\Core\Containers\FString) & InPackageName, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssets, [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > * OutDependencies )


description: Helper function to get the asset data from a file's history Note: will not query history to prevent recursion

code: static bool GetAssetDataFromFileHistory ( const [FString](API\Runtime\Core\Containers\FString) & InFileName, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssets, [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > * OutDependencies, int64 MaxFetchSize )


code: static bool GetAssetDataFromFileHistory ( [FSourceControlStatePtr](API\Developer\SourceControl\FSourceControlStatePtr) InSourceControlState, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssets, [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > * OutDependencies, int64 MaxFetchSize )


description:
Helper function to retrieve theFAssetDataassociated with a given package name
Whether the asset data could be retrieved or not

code: static bool GetAssetDataFromPackage ( const [FString](API\Runtime\Core\Containers\FString) & InPackageName, [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > & OutAssets, [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > * OutDependencies )


description:
Blocks until action is complete.
Success or failure of the operation

code: static bool GetFilesInDepotAtPath ( const [FString](API\Runtime\Core\Containers\FString) & PathToDirectory, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutFilesList, bool bIncludeDeleted, bool bSilent )


description:
Helper function to get the ini filename for storing global source control settings
the filename

code: static const [FString](API\Runtime\Core\Containers\FString) & GetGlobalSettingsIni()


description:
Helper function to get the ini filename for storing source control settings
the filename

code: static const [FString](API\Runtime\Core\Containers\FString) & GetSettingsIni()


description:
Quick check if currently set source control provider is enabled and available for use (server-based providers can use this to return whether the server is available or not)
true if source control is available, false if it is not

code: static bool IsAvailable()


description: Get the list of files and directories that source control should check when looking for changes.

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetSourceControlLocations ( const bool bContentOnly )


description:
Determine if there is a source control system enabled
true if enabled, false if not

code: static bool IsEnabled()


description: Get status text set by SourceControl system if an error occurs regardless whether bSilent is set or not. Only set if there was an error.


description: Find packages that can be reverted in Source Control locations

code: static bool ListRevertablePackages ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutRevertablePackageNames )


code: static bool MarkFileForAdd ( const [FString](API\Runtime\Core\Containers\FString) & InFile, bool bSilent )


code: static bool MarkFileForDelete ( const [FString](API\Runtime\Core\Containers\FString) & InFile, bool bSilent )


code: static bool MarkFilesForAdd ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, bool bSilent )


code: static bool MarkFilesForDelete ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, bool bSilent )


description:
Helper function to get a filename for a package name.
the filename

code: static [FString](API\Runtime\Core\Containers\FString) PackageFilename ( const [FString](API\Runtime\Core\Containers\FString) & InPackageName )


description:
Helper function to get a filename for a package.
the filename

code: static [FString](API\Runtime\Core\Containers\FString) PackageFilename ( const [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * InPackage )


description:
Helper function to convert package name array into a filename array.
an array of filenames

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > PackageFilenames ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InPackageNames )


description:
Helper function to convert package array into filename array.
an array of filenames

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > PackageFilenames ( const [TArray](API\Runtime\Core\Containers\TArray)< [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * > & InPackages )


description:
Blocks until action is complete.
Source control state - see USourceControlState. It will have bIsValid set to false if it could not have its values set.

code: static [FSourceControlState](API\Developer\SourceControl\FSourceControlState) QueryFileState ( const [FString](API\Runtime\Core\Containers\FString) & InFile, bool bSilent )


description:
Reverts all changes and then reloads the world.
true if succeeded.


description:
Reverts the provided files then reloads packages.
true if succeeded.

code: static bool RevertAndReloadPackages ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InPackagesToRevert, bool bRevertAll, bool bReloadWorld )


description:
Blocks until action is complete.
true if succeeded, false if failed and can callLastErrorMsg()for more info.

code: static bool RevertFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, bool bSilent )


code: static bool RevertFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, bool bSilent )


code: static bool RevertUnchangedFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, bool bSilent )


code: static bool RevertUnchangedFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, bool bSilent )


description: RevertFiles()

code: static void RevertUnchangedFiles ( [ISourceControlProvider](API\Developer\SourceControl\ISourceControlProvider) & InProvider, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles )


code: static bool SyncFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, bool bSilent )


code: static bool SyncFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, bool bSilent )


className: USourceControlHelpers

description: For example:

code: class USourceControlHelpers : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


description: Helper to access easily Enable Uncontrolled Changelists setting


description: Helper to access easily Enable Validation Tag setting

code: static bool IsValidationTagEnabled()


description: Helper to access easily Should Delete New Files On Revert setting


className: USourceControlPreferences

description: Settings for the Source Control Integration

code: class USourceControlPreferences : public [UDeveloperSettings](API\Runtime\DeveloperSettings\Engine\UDeveloperSettings)

bEnableUncontrolledChangelists

type: bool

description: Enables Uncontrolled Changelists features.

bEnableValidationTag

description: If enabled, adds a tag in changelist descriptions when they are validated

bShouldDeleteNewFilesOnRevert

description: If enabled, deletes new files when reverted.

CollectionChangelistTags

type: TArray<FString...

description: List of lines to add to any collection on checkin

SpecificCollectionChangelistTags

type: TMap<FName,FS...

description: Map of collection names and additional text to apply to changelist descriptions when checking them in


className: GetStandardStandaloneRenderer

description: Single function to create the standalone renderer for the running platform

module: StandaloneRenderer


description: Default constructor.

module: TargetDeviceServices

code: FTargetDeviceClaimDenied()


description: Creates and initializes a new instance.

code: FTargetDeviceClaimDenied ( const [FString](API\Runtime\Core\Containers\FString) & InDeviceName, const [FString](API\Runtime\Core\Containers\FString) & InHostName, const [FString](API\Runtime\Core\Containers\FString) & InHostUser )


className: FTargetDeviceClaimDenied

description: FTargetDeviceClaimRequest

code: struct FTargetDeviceClaimDenied

DeviceName

description: Holds the identifier of the device that is already claimed.

HostName

description: Holds the name of the host computer that claimed the device.

HostUser

description: Holds the name of the user that claimed the device.


description: Default constructor.

code: FTargetDeviceClaimed()


description: Creates and initializes a new instance.

code: FTargetDeviceClaimed ( const [FString](API\Runtime\Core\Containers\FString) & InDeviceName, const [FString](API\Runtime\Core\Containers\FString) & InHostName, const [FString](API\Runtime\Core\Containers\FString) & InHostUser )


className: FTargetDeviceClaimed

description: FTargetDeviceClaimDropped

code: struct FTargetDeviceClaimed

DeviceName

description: Holds the identifier of the device that is being claimed.

HostName

description: Holds the name of the host computer that is claiming the device.

description: Holds the name of the user that is claiming the device.


description: Default constructor.

code: FTargetDeviceServicePing()


description: Creates and initializes a new instance.

code: FTargetDeviceServicePing ( const [FString](API\Runtime\Core\Containers\FString) & InHostUser )


className: FTargetDeviceServicePing

description: Device discovery messages Implements a message for discovering target device services on the network.

code: struct FTargetDeviceServicePing

HostUser

description: Holds the name of the user who generated the ping.


className: FTargetDeviceServicePong

description: Implements a message that is sent in response to target device service discovery messages.

code: struct FTargetDeviceServicePong

Aggregated

description: Flag for the "All devices" proxy.

AllDevicesDefaultVariant

type: FName

description: Holds the default variant name of "All devices" proxy.

AllDevicesName

description: Holds the name of "All devices" proxy.

Authorized

description: Holds a flag indicating whether the device is authorized.

Connected

description: Holds a flag indicating whether the device is currently connected.

ConnectionType

description: Holds the connection type.

DefaultVariant

description: Holds the variant name of the default device.

DeviceUser

description: Holds the name of the user that we log in to remote device as, i.e "root".

DeviceUserPassword

description: Holds the password of the user that we log in to remote device as, i.e "12345".

HostName

description: Holds the name of the host computer that the device is attached to.

description: Holds the name of the user under which the host computer is running.

Make

description: Holds the make of the device, i.e. Microsoft or Sony.

Model

description: Holds the model of the device.

Name

description: Holds the human readable name of the device, i.e "Bob's XBox'.

OSVersion

description: Holds the device OS Version.

Shared

description: Holds a flag indicating whether this device is shared with other users on the network.

SupportsMultiLaunch

description: Holds a flag indicating whether the device supports running multiple application instances in parallel.

SupportsPowerOff

description: Holds a flag indicating whether the device can be powered off.

SupportsPowerOn

description: Holds a flag indicating whether the device can be powered on.

SupportsReboot

description: Holds a flag indicating whether the device can be rebooted.

SupportsVariants

description: Holds a flag indicating whether the device's target platform supports variants.

Type

description: Holds the device type.

Variants

type: TArray<FTarget...

description: List of the Flavors this service supports


description: Default constructor.

code: FTargetDeviceServicePowerOff()


description: Creates and initializes a new instance.

code: FTargetDeviceServicePowerOff ( const [FString](API\Runtime\Core\Containers\FString) & InOperator, bool InForce )


className: FTargetDeviceServicePowerOff

description: Miscellaneous messages Implements a message for powering on a target device.

code: struct FTargetDeviceServicePowerOff

Force

description: Holds a flag indicating whether the power-off should be enforced.

Operator

description: Holds the name of the user that wishes to power off the device.


description: Default constructor.

code: FTargetDeviceServicePowerOn()


description: Creates and initializes a new instance.

code: FTargetDeviceServicePowerOn ( const [FString](API\Runtime\Core\Containers\FString) & InOperator )


className: FTargetDeviceServicePowerOn

description: Implements a message for powering on a target device.

code: struct FTargetDeviceServicePowerOn

description: Holds the name of the user that wishes to power on the device.


description: Default constructor.

code: FTargetDeviceServiceReboot()


description: Creates and initializes a new instance.

code: FTargetDeviceServiceReboot ( const [FString](API\Runtime\Core\Containers\FString) & InOperator )


className: FTargetDeviceServiceReboot

description: Implements a message for rebooting a target device.

code: struct FTargetDeviceServiceReboot

description: Holds the name of the user that wishes to reboot the device.


description: Default constructor.


description: Creates and initializes a new instance.

code: FTargetDeviceServiceTerminateLaunchedProcess ( [FName](API\Runtime\Core\UObject\FName) InVariant, const [FString](API\Runtime\Core\Containers\FString) & InAppId )


description: FTargetDeviceServiceTerminateLaunchedProcess

AppID

description: Holds the identifier of the application to launch.

Variant

description: Holds the variant identifier of the target device to use.


description: Default constructor.

code: FTargetDeviceUnclaimed()


description: Creates and initializes a new instance.

code: FTargetDeviceUnclaimed ( const [FString](API\Runtime\Core\Containers\FString) & InDeviceName, const [FString](API\Runtime\Core\Containers\FString) & InHostName, const [FString](API\Runtime\Core\Containers\FString) & InHostUser )


className: FTargetDeviceUnclaimed

description: FTargetDeviceClaimRequest

code: struct FTargetDeviceUnclaimed

DeviceName

description: Holds the identifier of the device that is no longer claimed.

HostName

description: Holds the name of the host computer that had claimed the device.

HostUser

description: Holds the name of the user that had claimed the device.


className: FTargetDeviceVariant

description: Struct for a flavor's information

code: struct FTargetDeviceVariant


description:
Checks whether the device can launch multiple games or applications simultaneously.
true if launching multiple instances is supported, false otherwise.

code: const bool CanMultiLaunch() const


description:
Checks whether this device can be powered off remotely.
true if the device can be powered off, false otherwise.

code: bool CanPowerOff() const


description:
Checks whether this device can be powered on remotely.
true if the device can be powered on, false otherwise.

code: bool CanPowerOn() const


description:
Checks whether this device can be rebooted remotely.
true if the device can be rebooted, false otherwise.

code: bool CanReboot() const


description:
Checks whether this device's target platform supports variants.
true if the device's target platform supports variants, false otherwise.

code: bool CanSupportVariants() const


description:
Gets the type of connection for this device.
Device type.

code: const [FString](API\Runtime\Core\Containers\FString) & GetConnectionType() const


description:
Gets the name of the (device's) user that is logged in on a device.
Device user name.

code: const [FString](API\Runtime\Core\Containers\FString) & GetDeviceUser() const


description:
Gets the password of the (device's) user that is logged in on a device.
Device user password.

code: const [FString](API\Runtime\Core\Containers\FString) & GetDeviceUserPassword() const


description:
Gets the name of the host machine that claimed the device.
Host name string.

code: const [FString](API\Runtime\Core\Containers\FString) & GetHostName() const


description:
Gets the name of the user that claimed the device.
User name.

code: const [FString](API\Runtime\Core\Containers\FString) & GetHostUser() const


description:
Gets the device make (i.e. Apple or Sony).
Device make.

code: const [FString](API\Runtime\Core\Containers\FString) & GetMake() const


description:
Gets the device model (i.e. PS3 or XBox).
Device model.

code: const [FString](API\Runtime\Core\Containers\FString) & GetModel() const


description:
Gets the name of the device (i.e. network name or IP address).
Device name string.

code: const [FString](API\Runtime\Core\Containers\FString) & GetName() const


description:
Gets the number of variants this device supports
The number of variants supported.

code: int32 GetNumVariants() const


description:
Gets the OS Version of the device
Device OS VErsion.

code: const [FString](API\Runtime\Core\Containers\FString) & GetOSVersion() const


description:
Gets the Vanilla platform of the device variant.
Platform Display Name string.

code: [FText](API\Runtime\Core\Internationalization\FText) GetPlatformDisplayName ( [FName](API\Runtime\Core\UObject\FName) InVariant ) const


description:
Gets the identifier of the device.
The target device identifier.

code: const [FString](API\Runtime\Core\Containers\FString) GetTargetDeviceId ( [FName](API\Runtime\Core\UObject\FName) InVariant ) const


description: Gets a list of device identifiers for an aggregate (All_devices_on) proxy

code: const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & GetTargetDeviceIds ( [FName](API\Runtime\Core\UObject\FName) InVariant ) const


description:
Gets the variant name of the target device.
The target device variant name.

code: [FName](API\Runtime\Core\UObject\FName) GetTargetDeviceVariant ( const [FString](API\Runtime\Core\Containers\FString) & InDeviceId ) const


description:
Gets the target platform of the device variant.
Target Platform Id.

code: [FName](API\Runtime\Core\UObject\FName) GetTargetPlatformId ( [FName](API\Runtime\Core\UObject\FName) InVariant ) const


description:
Gets the target platform of the device variant.
Target Platform Name string.

code: [FString](API\Runtime\Core\Containers\FString) GetTargetPlatformName ( [FName](API\Runtime\Core\UObject\FName) InVariant ) const


description:
Gets the device type (i.e. Console, PC or Mobile).
Device type.

code: const [FString](API\Runtime\Core\Containers\FString) & GetType() const


description:
Gets the Vanilla platform of the device variant.
Vanilla Platform Id.

code: [FName](API\Runtime\Core\UObject\FName) GetVanillaPlatformId ( [FName](API\Runtime\Core\UObject\FName) InVariant ) const


description:
Gets the list of variants this device supports
The number of variants in the list.

code: int32 GetVariants ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutVariants ) const


description:
Checks whether this device proxy contains a variant for the provided target device.
true if this device has a variant of the provided DeviceId.

code: bool HasDeviceId ( const [FString](API\Runtime\Core\Containers\FString) & InDeviceId ) const


description:
Checks whether this device proxy contains a variant for the provided platform.
true if this device has a variant of the provided Target Platform .

code: bool HasTargetPlatform ( [FName](API\Runtime\Core\UObject\FName) InTargetPlatformId ) const


description:
Checks whether this device proxy contains a variant
true is this variant is found.

code: bool HasVariant ( [FName](API\Runtime\Core\UObject\FName) InVariant ) const


description:
Checks if this is an aggregate (All_devices_on) proxy.
true if the device is aggregated, false otherwise.

code: virtual bool IsAggregated() const


description:
Checks whether the device is authorized.
true if the device is authorized, false otherwise.

code: bool IsAuthorized() const


description:
Checks whether the device is currently connected.
true if the device is connected, false otherwise.

code: bool IsConnected() const


description:
Checks whether this device is being shared with other users.
true if the device is being shared, false otherwise.

code: bool IsShared() const


description: Reboot

code: void PowerOff ( bool Force )


description: Reboot

code: void PowerOn()


description: PowerOn

code: void Reboot()


description:
Cancel the application running on the device
true if the launch has been successfully terminated, false otherwise.

code: bool TerminateLaunchedProcess ( [FName](API\Runtime\Core\UObject\FName) InVariant, const [FString](API\Runtime\Core\Containers\FString) & ProcessIdentifier )


description: Virtual destructor.

code: virtual ~ITargetDeviceProxy()


className: ITargetDeviceProxy

description: Interface for target device proxies.

code: class ITargetDeviceProxy


description: GetProxies

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITargetDeviceProxy](API\Developer\TargetDeviceServices\ITargetDeviceProxy) > FindOrAddProxy ( const [FString](API\Runtime\Core\Containers\FString) & Name )


description: GetProxies

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDeviceProxy](API\Developer\TargetDeviceServices\ITargetDeviceProxy) > FindProxy ( const [FString](API\Runtime\Core\Containers\FString) & Name )


description: GetProxies

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDeviceProxy](API\Developer\TargetDeviceServices\ITargetDeviceProxy) > FindProxyDeviceForTargetDevice ( const [FString](API\Runtime\Core\Containers\FString) & DeviceId )


className: FOnTargetDeviceProxyAdded

description: Gets an event delegate that is executed when a target device proxy was added.

code: class FOnTargetDeviceProxyAdded : public TBaseMulticastDelegate_OneParam< void, const TSharedRef< ITargetDeviceProxy > & >


className: FOnTargetDeviceProxyRemoved

description: Gets an event delegate that is executed when a target device proxy was removed.

code: class FOnTargetDeviceProxyRemoved : public TBaseMulticastDelegate_OneParam< void, const TSharedRef< ITargetDeviceProxy > & >


description: FindProxyDeviceForTargetDevice

code: void GetAllProxies ( [FName](API\Runtime\Core\UObject\FName) TargetPlatformName, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDeviceProxy](API\Developer\TargetDeviceServices\ITargetDeviceProxy) >> & OutProxies )


description: FindProxyDeviceForTargetDevice

code: void GetProxies ( [FName](API\Runtime\Core\UObject\FName) TargetPlatformName, bool IncludeUnshared, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDeviceProxy](API\Developer\TargetDeviceServices\ITargetDeviceProxy) >> & OutProxies )


description: Virtual destructor.

code: virtual ~ITargetDeviceProxyManager()


className: ITargetDeviceProxyManager

description: Interface for device proxy managers.

code: class ITargetDeviceProxyManager


description:
Adds a flavor to this device.
true if the service can start, false otherwise.

code: void AddTargetDevice ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDevice](API\Developer\TargetPlatform\Interfaces\ITargetDevice), ESPMode::ThreadSafe > InDevice )


description:
A service can be started if it has a valid device and the device is connected. This method does not take into account whether the service is already started.
true if the service can start, false otherwise.

code: bool CanStart ( [FName](API\Runtime\Core\UObject\FName) InFlavor ) const


description:
Gets the name of the host that has a claim on the device.
Host name string.

code: const [FString](API\Runtime\Core\Containers\FString) & GetClaimHost()


description:
Gets the name of the user that has a claim on the device.
User name string.

code: const [FString](API\Runtime\Core\Containers\FString) & GetClaimUser()


description:
Gets the target device for the supplied flavor, if no flavor is specified then the default device flavor is returned.
A pointer to the target device.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDevice](API\Developer\TargetPlatform\Interfaces\ITargetDevice), ESPMode::ThreadSafe > GetDevice ( [FName](API\Runtime\Core\UObject\FName) InFlavor ) const


description:
Gets the name of the device that this service exposes.
The human readable device name.


description:
Gets the display name of the platform of device that this service exposes.
The human readable platform name.


description:
Gets the name of the platform of device that this service exposes.
The platform name.


description:
Checks whether the service is currently running.
true if the service is running, false otherwise.

code: bool IsRunning() const


description: SetShared

code: bool IsShared() const


description:
Gets number of target devices.
number of target devices in this device service.

code: int32 NumTargetDevices()


description:
Removes a flavor from this device.
true if the service can start, false otherwise.

code: void RemoveTargetDevice ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDevice](API\Developer\TargetPlatform\Interfaces\ITargetDevice), ESPMode::ThreadSafe > InDevice )


description: IsShared

code: void SetShared ( bool InShared )


description: Stop

code: bool Start()


description: Stop

code: void Stop()


description: Virtual destructor.

code: virtual ~ITargetDeviceService()


className: ITargetDeviceService

description: ITargetDeviceProxy

code: class ITargetDeviceService


description: RemoveStartupService

code: bool AddStartupService ( const [FString](API\Runtime\Core\Containers\FString) & DeviceName )


className: FOnTargetDeviceServiceAdded

description: Gets an event delegate that is executed when a target device service was added.

code: class FOnTargetDeviceServiceAdded : public TBaseMulticastDelegate_OneParam< void, const ITargetDeviceServiceRef & >


className: FOnTargetDeviceServiceRemoved

description: Gets an event delegate that is executed when a target device service was removed.

code: class FOnTargetDeviceServiceRemoved : public TBaseMulticastDelegate_OneParam< void, const ITargetDeviceServiceRef & >


description:
Gets the collection of target device services managed by this instance.
The number of services returned.

code: int32 GetServices ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDeviceService](API\Developer\TargetDeviceServices\ITargetDeviceService), ESPMode::ThreadSafe >> & OutServices )


description: GetServices

code: void RemoveStartupService ( const [FString](API\Runtime\Core\Containers\FString) & DeviceName )


description: Virtual destructor.

code: virtual ~ITargetDeviceServiceManager()


className: ITargetDeviceServiceManager

description: Interface for target device service managers.

code: class ITargetDeviceServiceManager


className: ITargetDeviceServicePtr

description: Type definition for shared pointers to instances ofITargetDeviceService.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ITargetDeviceService](API\Developer\TargetDeviceServices\ITargetDeviceService), ESPMode::ThreadSafe > ITargetDeviceServicePtr


className: ITargetDeviceServiceRef

description: Type definition for shared references to instances ofITargetDeviceService.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ITargetDeviceService](API\Developer\TargetDeviceServices\ITargetDeviceService), ESPMode::ThreadSafe > ITargetDeviceServiceRef


description: GetDeviceServiceManager


description: GetDeviceProxyManager


description: Virtual destructor.

code: virtual ~ITargetDeviceServicesModule()


className: ITargetDeviceServicesModule

description: Interface for target device services modules.

code: class ITargetDeviceServicesModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Helper method to fill a dependencies array for the shader compiler with absolute paths, passing a relative path to the Engine as the parameter.

module: TargetPlatform

code: static void AddDependencySCArrayHelper ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutDependencies, const [FString](API\Runtime\Core\Containers\FString) & DependencyRelativePath )


description:
Add a target device by name.
true if the device was added, false otherwise.

code: virtual bool AddDevice ( const [FString](API\Runtime\Core\Containers\FString) & DeviceName, bool bDefault )


description:
Add a target device.
true if the device was added, false otherwise.

code: virtual bool AddDevice ( const [FString](API\Runtime\Core\Containers\FString) & DeviceId, const [FString](API\Runtime\Core\Containers\FString) & DeviceUserFriendlyName, const [FString](API\Runtime\Core\Containers\FString) & Username, const [FString](API\Runtime\Core\Containers\FString) & Password, bool bDefault )


description:
Checks whether this platform will allow development objects to be cooked. This is separate from AllowsEditorObjects because cooked editors can be shipped with editor objects but still need to remove development assets.
true if this platform allows development objects to be cooked, false otherwise.

code: virtual bool AllowsDevelopmentObjects() const


description:
Checks whether this platform will allow editor objects to be cooked, as opposed to editoronly properties. This will allow a target platform to cook editoronly objects, but as if they were being cooked for a client. This is useful for a cooked editor scenario, where every pacakge is cooked, editor and game alike.
true if this platform allows editor objects to be cooked, false otherwise.

code: virtual bool AllowsEditorObjects() const


description: Analytics helper functions

code: static void AppendAnalyticsEventConfigBool ( [TArray](API\Runtime\Core\Containers\TArray)< struct [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & AnalyticsParamArray, const TCHAR * ConfigSection, const TCHAR * ConfigKey, const [FString](API\Runtime\Core\Containers\FString) & IniFileName, const TCHAR * AnalyticsKeyNameOverride )


code: static void AppendAnalyticsEventConfigInt ( [TArray](API\Runtime\Core\Containers\TArray)< struct [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & AnalyticsParamArray, const TCHAR * ConfigSection, const TCHAR * ConfigKey, const [FString](API\Runtime\Core\Containers\FString) & IniFileName, const TCHAR * AnalyticsKeyNameOverride )


code: static void AppendAnalyticsEventConfigFloat ( [TArray](API\Runtime\Core\Containers\TArray)< struct [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & AnalyticsParamArray, const TCHAR * ConfigSection, const TCHAR * ConfigKey, const [FString](API\Runtime\Core\Containers\FString) & IniFileName, const TCHAR * AnalyticsKeyNameOverride )


code: static void AppendAnalyticsEventConfigString ( [TArray](API\Runtime\Core\Containers\TArray)< struct [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & AnalyticsParamArray, const TCHAR * ConfigSection, const TCHAR * ConfigKey, const [FString](API\Runtime\Core\Containers\FString) & IniFileName, const TCHAR * AnalyticsKeyNameOverride )


code: static void AppendAnalyticsEventConfigArray ( [TArray](API\Runtime\Core\Containers\TArray)< struct [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & AnalyticsParamArray, const TCHAR * ConfigSection, const TCHAR * ConfigKey, const [FString](API\Runtime\Core\Containers\FString) & IniFileName, const TCHAR * AnalyticsKeyNameOverride )


description:
Checks whether this platform supports shader compilation over XGE interface.
true if this platform can distribute shader compilation threads with XGE.

code: virtual bool CanSupportRemoteShaderCompile() const


description:
Checks whether the platform's build requirements are met so that we can do things like package for the platform.
A mask of ETargetPlatformReadyStatus flags to indicate missing requirements, or 0 if all requirements are met.

code: virtual int32 CheckRequirements ( bool bProjectHasCode, EBuildConfiguration Configuration, bool bRequiresAssetNativization, [FString](API\Runtime\Core\Containers\FString) & OutTutorialPath, [FString](API\Runtime\Core\Containers\FString) & OutDocumentationPath, [FText](API\Runtime\Core\Internationalization\FText) & CustomizedLogMessage ) const


description: Copy a file to the target

code: virtual bool CopyFileToTarget ( const [FString](API\Runtime\Core\Containers\FString) & DeviceId, const [FString](API\Runtime\Core\Containers\FString) & HostFilename, const [FString](API\Runtime\Core\Containers\FString) & TargetFilename, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & CustomPlatformData )


description: PlatformName

code: virtual [FText](API\Runtime\Core\Internationalization\FText) DisplayName() const


description: Gets whether the platform will use SH2 instead of SH3 for sky irradiance.

code: virtual bool ForcesSimpleSkyDiffuse() const


code: const [Audio::FAudioFormatSettings](API\Runtime\Engine\Sound\FAudioFormatSettings) & GetAudioFormatSettings() const


description: Project settings to check to determine if a build should occur

code: virtual void GetBuildProjectSettingKeys ( [FString](API\Runtime\Core\Containers\FString) & OutSection, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InBoolKeys, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InIntKeys, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InStringKeys ) const


description: Returns the config system object usable by this TargetPlatform. It should not be modified in anyway

code: virtual [FConfigCacheIni](API\Runtime\Core\Misc\FConfigCacheIni) * GetConfigSystem() const


description: Returns custom DeviceManager widget creator for this platform


description:
Gets down sample mesh distance field divider.
1 if platform does not need to downsample mesh distance fields

code: virtual float GetDownSampleMeshDistanceFieldDivider() const


description: Gets a list of package names to cook when cooking this platform

code: virtual void GetExtraPackagesToCook ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & PackageNames ) const


description:
Gets an integer representing the height fog mode for opaque materials on a platform.
0 if no override (i.e. use r.VertexFoggingForOpaque from project settings); 1 if pixel fog; 2 if vertex fog.

code: virtual int32 GetHeightFogModeForOpaque() const


description: Returns the information about the platform as a whole

code: virtual const [FDataDrivenPlatformInfo](API\Runtime\Core\Misc\FDataDrivenPlatformInfo) & GetPlatformInfo() const


description:
The implementation will assign an ordinal to each target platform at startup, assigning a value of 0, 1, 2, etc in order to make the ordinals usable as array / bit mask indices.
int32 A unique integer which may be used to identify target platform during the current session only (note: not stable across runs).

code: virtual int32 GetPlatformOrdinal() const


description: Gather per-project cook/package analytics

code: virtual void GetPlatformSpecificProjectAnalytics ( [TArray](API\Runtime\Core\Containers\TArray)< struct [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & AnalyticsParamArray ) const


description: Gets the shader formats that support ray tracing for this target platform.

code: virtual void GetRayTracingShaderFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFormats ) const


description: Provide platform specific file dependency patterns for SN-DBS shader compilation.

code: virtual void GetShaderCompilerDependencies ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutDependencies ) const


description: Gets static mesh offline BVH mode

code: virtual [EOfflineBVHMode](API\Developer\TargetPlatform\Interfaces\EOfflineBVHMode) GetStaticMeshOfflineBVHMode() const


description: Returns the information about this target platform

code: virtual const [PlatformInfo::FTargetPlatformInfo](API\Developer\DesktopPlatform\FTargetPlatformInfo) & GetTargetPlatformInfo() const


description:
Gets the variant priority of this platform
float priority for this platform variant.

code: virtual float GetVariantPriority() const


description: Initializes the host platform to support target devices (may be called multiple times after an SDK is installed while running)

code: virtual bool InitializeHostPlatform()


description: Checks whether this platform is enabled for the given plugin in the currently active project.

code: virtual bool IsEnabledForPlugin ( const [IPlugin](API\Runtime\Projects\Interfaces\IPlugin) & Plugin ) const


description:
Checks whether the platform's SDK requirements are met so that we can do things like package for the platform
true if the platform is ready for use

code: virtual bool IsSdkInstalled ( bool bProjectHasCode, [FString](API\Runtime\Core\Containers\FString) & OutDocumentationPath ) const


description:
Package a build for the given platform
bool true on success, false otherwise.

code: virtual bool PackageBuild ( const [FString](API\Runtime\Core\Containers\FString) & InPackgeDirectory )


description:
Checks whether the current project needs a temporary .target.cs file to be packaged as a code project.
True if a temporary target is required

code: virtual bool RequiresTempTarget ( bool bProjectHasCode, EBuildConfiguration Configuration, bool bRequiresAssetNativization, [FText](API\Runtime\Core\Internationalization\FText) & OutReason ) const


description: Returns wheter or not this 16bit index buffer should be promoted to 32bit

code: virtual bool ShouldExpandTo32Bit ( const uint16 * Indices, const int32 NumIndices ) const


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

code: virtual bool SendLowerCaseFilePaths() const


description:
Checks whether the target platform supports the specified value for the specified type of support
true if the feature is supported, false otherwise.

code: virtual bool SupportsValueForType ( [FName](API\Runtime\Core\UObject\FName) SupportedType, [FName](API\Runtime\Core\UObject\FName) RequiredSupportedValue ) const


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

code: virtual bool SupportsVariants() const


description: Gets whether the platform uses ASTC HDR

code: virtual bool UsesASTCHDR() const


description: Gets whether the platform should output velocity in the base pass.

code: virtual bool UsesBasePassVelocity() const


description: Gets whether the platform should use DBuffer for decals.

code: virtual bool UsesDBuffer() const


description: Gets whether the platform will use distance fields.

code: virtual bool UsesDistanceFields() const


description: Gets whether the platform should use forward shading or not.

code: virtual bool UsesForwardShading() const


description: Gets whether the platform uses Mobile AO

code: virtual bool UsesMobileAmbientOcclusion() const


description: Gets whether the platform will use ray tracing.

code: virtual bool UsesRayTracing() const


description: Gets whether the platform will use selective outputs in the base pass shaders.

code: virtual bool UsesSelectiveBasePassOutputs() const


description: Gets whether the platform will encode depth velocity.

code: virtual bool VelocityEncodeDepth() const


code: FTargetPlatformBase ( const [PlatformInfo::FTargetPlatformInfo](API\Developer\DesktopPlatform\FTargetPlatformInfo) *const InPlatformInfo )


className: FTargetPlatformBase

description: Base class for target platforms.

code: class FTargetPlatformBase : public [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform)

PlatformInfo

type: constPlatformI...

description: Information about this platform


description: Gets the name of the device profile to use when cooking this TargetPlatform

code: virtual [FString](API\Runtime\Core\Containers\FString) CookingDeviceProfileName() const


description: PlatformName

code: virtual [FString](API\Runtime\Core\Containers\FString) IniPlatformName() const


description:
Checks whether this platform has only editor data (typically desktop platforms).
true if this platform has editor only data, false otherwise.

code: virtual bool HasEditorOnlyData() const


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

code: virtual bool IsClientOnly() const


description:
For example, when running on Windows, the WindowsITargetPlatformwill return true and all other platforms will return false.
true if this platform is running, false otherwise.

code: virtual bool IsRunningPlatform() const


description:
Checks whether this platform is only a server.
true if this platform has no graphics or audio, etc, false otherwise.

code: virtual bool IsServerOnly() const


description: DisplayName

code: virtual [FString](API\Runtime\Core\Containers\FString) PlatformName() const


description: A simplified version for TPs that never will have Editor or ServerOnly versions, potentially multiple CookFlavors, as well as IN VERY RARE CASES, a different runtime IniPlatformName than what is passed in here (an example being TVOS and IOS, where passing in TVOS properties is very complicated) Note that if we delayed the Info creation, we could just use this->IniPlatformName()and override that in, say TVOS, but we can't call a virtual here, so we pass it up into the ctor

code: TNonDesktopTargetPlatformBase ( bool bInIsClientOnly, const TCHAR * CookFlavor, const TCHAR * OverrideIniPlatformName )


className: TNonDesktopTargetPlatformBase

code: template<typename TPlatformProperties> class TNonDesktopTargetPlatformBase : public [TTargetPlatformBase< TPlatformProperties >](API\Developer\TargetPlatform\Common\TTargetPlatformBase)

bIsClientOnly

description: True if this target platform is client-only, ie strips out server stuff


description:
Gets the alignment of memory mapping for this platform, typically the page size.
alignment of memory mapping.

code: virtual int64 GetMemoryMappingAlignment() const


description: Return the TargetType this platform uses at runtime. Some TargetPlatforms like CookedEditors need to cook with one type, like Client, but then will run as an Editor. Decisions made based solely on the cook type may cause data mismatches if the runtime type is different. This is also useful for knowing what plugins will be enabled at runtime.

code: virtual EBuildTargetType GetRuntimePlatformType() const


description:
Gets a new compression format to use in place of Zlib. This should be rarely implemented
Compression format to use instead of Zlib

code: virtual [FName](API\Runtime\Core\UObject\FName) GetZlibReplacementFormat() const


description:
Checks whether this platform has a secure shippable package format, and therefore doesn't need any encryption or signing support
true if this platform requires cooked data, false otherwise.

code: virtual bool HasSecurePackageFormat() const


description:
Checks whether this platform is little endian.
true if this platform is little-endian, false otherwise.

code: virtual bool IsLittleEndian() const


description: Returns true if the target platform will be able to be initialized with an FPlatformInfo. Because FPlatformInfo now comes from a .ini file, it's possible that the .dll exists, but the .ini does not (should be uncommon, but is necessary to be handled)

code: static bool IsUsable()


description:
Checks whether this platform requires cooked data (typically console platforms).
true if this platform requires cooked data, false otherwise.

code: virtual bool RequiresCookedData() const


description:
Checks whether this platform requires the originally released version (in addition to the previously released version) to create a patch
true if this platform requires the originally released version, false otherwise.

code: virtual bool RequiresOriginalReleaseVersionForPatch() const


description:
Checks whether this platform requires user credentials (typically server platforms).
enum if this platform requires user credentials.


description: Returns true if the platform supports the AutoSDK system

code: virtual bool SupportsAutoSDK() const


description:
Checks whether this platform supports the specified build target, i.e. Game or Editor.
true if the build target is supported, false otherwise.

code: virtual bool SupportsBuildTarget ( EBuildTargetType TargetType ) const


description:
Checks whether the target platform supports the specified feature.
true if the feature is supported, false otherwise.

code: virtual bool SupportsFeature ( [ETargetPlatformFeatures](API\Developer\TargetPlatform\Interfaces\ETargetPlatformFeatures) Feature ) const


description: Gets whether the platform will use ray tracing.

code: virtual bool UsesRayTracing() const


description: Constructor that makes a TPI based solely on TPlatformProperties

code: TTargetPlatformBase()


description: Constructor that already has a TPI (notably coming from TNonDesktopTargetPlatform)

code: TTargetPlatformBase ( [PlatformInfo::FTargetPlatformInfo](API\Developer\DesktopPlatform\FTargetPlatformInfo) * PremadePlatformInfo )


className: TTargetPlatformBase

description: Template for target platforms.

code: template<typename TPlatformProperties> class TTargetPlatformBase : public [FTargetPlatformBase](API\Developer\TargetPlatform\Common\FTargetPlatformBase)


className: EOfflineBVHMode

code: enum EOfflineBVHMode { Disabled, MaximizePerformance, MinimizeMemory, }


className: ETargetDeviceConnectionTypes

description: Enumerates how the target device is connected

code: enum ETargetDeviceConnectionTypes { Unknown, USB, Wifi, Ethernet, Simulator, Proprietary, }


className: EPlatformAuthentication

code: enum EPlatformAuthentication { Never, Possible, Always, }


className: ETargetDeviceFeatures

description: Enumerates features that may be supported by target devices.

code: enum ETargetDeviceFeatures { MultiLaunch, PowerOff, PowerOn, ProcessSnapshot, Reboot, }


className: ETargetDeviceThreadStates

description: Enumerates states of threads running on a target device.

code: enum ETargetDeviceThreadStates { Unknown, CanRun, Inactive, Inhibited, RunQueue, Running, }


className: ETargetDeviceTypes

description: Enumerates target device types.

code: enum ETargetDeviceTypes { Indeterminate, Browser, Console, Desktop, Phone, Tablet, HMD, }


className: ETargetPlatformFeatures

description: Enumerates features that may be supported by target platforms.

code: enum ETargetPlatformFeatures { AudioStreaming, DistanceFieldShadows, DistanceFieldAO, GrayscaleSRGB, HighQualityLightmaps, LowQualityLightmaps, MultipleGameInstances, Packaging, SdkConnectDisconnect, TextureStreaming, MeshLODStreaming, UserCredentials, MobileRendering, DeferredRendering, ShouldSplitPaksIntoSmallerSizes, HalfFloatVertexFormat, DeviceOutputLog, MemoryMappedFiles, MemoryMappedAudio, MemoryMappedAnimation, SparseTextures, VirtualTextureStreaming, LumenGI, HardwareLZDecompression, CookFileRegionMetadata, DirectDataExchange, NormalmapLAEncodingMode, ShowAsPlatformGroup, }


className: FOnTargetPlatformsInvalidated

code: typedef TMulticastDelegate_NoParams< void > FOnTargetPlatformsInvalidated


className: FSoundQualityInfo

description: A non-UObject based structure used to pass data about a sound node wave around the engine and tools.

code: struct FSoundQualityInfo

bStreaming

description: Holds whether the sound will be streamed.

DebugName

description: Holds a string for debugging purposes.

Duration

type: float

description: Holds the length of the sound in seconds.

NumChannels

description: Holds the number of distinct audio channels.

Quality

description: Holds the quality value ranging from 1 [poor] to 100 [very good].

SampleDataSize

description: Holds the size of sample data in bytes.

SampleRate

description: Holds the number of PCM samples per second.


className: ETargetDeviceThreadWaitStates

description: Enumerates wait states of threads running on a target device.

code: enum ETargetDeviceThreadWaitStates { Unknown, Locked, Sleeping, Suspended, Swapped, Waiting, }


description:
Gets the platform name.
Platform name.

code: const [FString](API\Runtime\Core\Containers\FString) & GetPlatformName() const


description:
Gets the device identifier.
Device identifier.

code: const [FString](API\Runtime\Core\Containers\FString) & GetDeviceName() const


description:
Checks whether this target device identifier is valid.
true if the identifier is valid, false otherwise.

code: bool IsValid() const


description:
Compares this device identifier with the given device identifier for equality.
true if the identifiers are equal, false otherwise.

code: bool operator== ( const [FTargetDeviceId](API\Developer\TargetPlatform\Interfaces\FTargetDeviceId) & Other ) const


description:
Compares this device identifier with the given device identifier for inequality.
true if the identifiers are not equal, false otherwise.

code: bool operator!= ( const [FTargetDeviceId](API\Developer\TargetPlatform\Interfaces\FTargetDeviceId) & Other ) const


description:
Converts a string to a target device identifier.
true if the string was converted successfully, false otherwise.

code: static bool Parse ( const [FString](API\Runtime\Core\Containers\FString) & IdString, [FTargetDeviceId](API\Developer\TargetPlatform\Interfaces\FTargetDeviceId) & OutId )


description:
Gets the string representation for this device identifier.
String representation.


description: Default constructor.

code: FTargetDeviceId()


description: Creates and initializes a new target device identifier.

code: FTargetDeviceId ( const [FString](API\Runtime\Core\Containers\FString) & InPlatformName, const [FString](API\Runtime\Core\Containers\FString) & InDeviceName )


className: FTargetDeviceId

description: Implements a target devices identifier.

code: class FTargetDeviceId


className: FTargetDeviceProcessInfo

description: Structure for information for processes that are running on a target device.

code: struct FTargetDeviceProcessInfo

Id

description: Holds the process identifier.

Name

description: Holds the process name.

ParentId

description: Holds the identifier of the parent process.

Threads

description: Holds the collection of threads that belong to this process.

UserName

description: The name of the user that owns this process.


className: FTargetDeviceThreadInfo

description: Structure for thread information.

code: struct FTargetDeviceThreadInfo

ExitCode

description: Holds the exit code.

Id

description: Holds the thread identifier.

Name

description: Holds the name of the thread.

StackSize

description: Holds the thread's stack size.

State

type: ETargetDeviceTh...

description: Holds the thread's current state.

WaitState

description: Holds the thread's current wait state.


code: bool operator== ( const [FTargetPlatform](API\Developer\TargetPlatform\Interfaces\FTargetPlatform) & Other ) const


code: FTargetPlatform ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) & Platform )


code: bool operator< ( const [FTargetPlatform](API\Developer\TargetPlatform\Interfaces\FTargetPlatform) & Other ) const


code: void Add ( const [FTargetPlatform](API\Developer\TargetPlatform\Interfaces\FTargetPlatform) & Platform )


className: FTargetPlatform

description: ITargetPlatform::GetPlatformOrdinal()

code: struct FTargetPlatform


description: Check if this set contains any of the members of the Other set.

code: bool Contains ( const [FTargetPlatform](API\Developer\TargetPlatform\Interfaces\FTargetPlatform) & Platform ) const


code: bool ContainsAny ( const [FTargetPlatformSet](API\Developer\TargetPlatform\Interfaces\FTargetPlatformSet) & Other ) const


description: Iterate over all set members

code: template<typename Func> void ForEach ( Func && Callback ) const


code: bool operator== ( const [FTargetPlatformSet](API\Developer\TargetPlatform\Interfaces\FTargetPlatformSet) & Other ) const


code: void Remove ( const [FTargetPlatform](API\Developer\TargetPlatform\Interfaces\FTargetPlatform) & Platform )


code: void Merge ( const [FTargetPlatformSet](API\Developer\TargetPlatform\Interfaces\FTargetPlatformSet) & Other )


description: Remove all members from the Platforms set from this set.

code: void Remove ( const [FTargetPlatformSet](API\Developer\TargetPlatform\Interfaces\FTargetPlatformSet) & Platforms )


className: FTargetPlatformSet

description: Target platform set implementation using bitmask for compactness

code: class FTargetPlatformSet


description:
Note: This method is not currently used yet.
true if this audio format can cook in parallel, false otherwise.

code: virtual bool AllowParallelBuild() const


description:
Cooks the source data for the platform and stores the cooked data internally.
true on success, false otherwise.

code: bool Cook ( [FName](API\Runtime\Core\UObject\FName) Format, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & SrcBuffer, [FSoundQualityInfo](API\Developer\TargetPlatform\Interfaces\FSoundQualityInfo) & QualityInfo, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutBuffer ) const


description:
Cooks up to 8 mono files into a multi-stream file (e.g. 5.1). The front left channel is required, the rest are optional.
true if succeeded, false otherwise

code: bool CookSurround ( [FName](API\Runtime\Core\UObject\FName) Format, const [TArray](API\Runtime\Core\Containers\TArray)< [TArray](API\Runtime\Core\Containers\TArray)< uint8 > > & SrcBuffers, [FSoundQualityInfo](API\Developer\TargetPlatform\Interfaces\FSoundQualityInfo) & QualityInfo, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutBuffer ) const


description:
Extracts the embedded seek-table, removing it, and outputting it separately. NOTE:TArrayis modified in place. The seek-table is parsed and removed from it.
Success or failure

code: virtual bool ExtractSeekTableForStreaming ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InOutBuffer, [FSeekTable](API\Developer\TargetPlatform\Interfaces\IAudioFormat\FSeekTable) & OutSeektable ) const


className: FSeekTable

code: struct FSeekTable

Offsets

type: TArray< uint32 ...


description: This is called prior toSplitDataForStreaming(), and is used for determining FirstChunkMaxSize.

code: virtual int32 GetMinimumSizeForInitialChunk ( [FName](API\Runtime\Core\UObject\FName) Format, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & SrcBuffer ) const


description: Gets the list of supported formats.

code: void GetSupportedFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFormats ) const


description:
Gets the current version of the specified audio format.
Version number.

code: uint16 GetVersion ( [FName](API\Runtime\Core\UObject\FName) Format ) const


description:
This function is, as far as I can tell, unused.
The size of the compressed audio, or 0 on failure.

code: int32 Recompress ( [FName](API\Runtime\Core\UObject\FName) Format, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & SrcBuffer, [FSoundQualityInfo](API\Developer\TargetPlatform\Interfaces\FSoundQualityInfo) & QualityInfo, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutBuffer ) const


code: virtual bool RequiresStreamingSeekTable() const


description:
Splits compressed data into chunks suitable for streaming audio.
Whether bulk data could be split for streaming.

code: virtual bool SplitDataForStreaming ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & SrcBuffer, [TArray](API\Runtime\Core\Containers\TArray)< [TArray](API\Runtime\Core\Containers\TArray)< uint8 >> & OutBuffers, const int32 FirstChunkMaxSize, const int32 MaxChunkSize ) const


description: Virtual destructor.

code: virtual ~IAudioFormat()


className: IAudioFormat

description: Interface for audio formats.

code: class IAudioFormat


description:
Gets the audio format.
The audio format interface.


description: Virtual destructor.

code: ~IAudioFormatModule()


className: IAudioFormatModule

description: Interface for audio format modules.

code: class IAudioFormatModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


code: void AddDevice ( const [FString](API\Runtime\Core\Containers\FString) & InPlatformName, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & UserData )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > CreateAddDeviceWidget ( const [FString](API\Runtime\Core\Containers\FString) & InPlatformName )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > CreateDeviceInfoWidget ( const [FString](API\Runtime\Core\Containers\FString) & InPlatformName, const [ITargetDevicePtr](API\Developer\TargetPlatform\Interfaces\ITargetDevicePtr) & InDevice )


code: bool IsAddDeviceInputValid ( const [FString](API\Runtime\Core\Containers\FString) & InPlatformName, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & UserData )


code: bool RequiresProjectBuild ( const [FName](API\Runtime\Core\UObject\FName) & InPlatformInfoName, [FText](API\Runtime\Core\Internationalization\FText) & OutReason ) const


className: IProjectBuildMutatorFeature

code: class IProjectBuildMutatorFeature : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: Appends shader key text to the provided key string for use in DDC unique key construction.

code: virtual void AppendToKeyString ( [FString](API\Runtime\Core\Containers\FString) & KeyString ) const


description:
Can the shader format compile shaders to the native binary format for the platform.
True if the native compiler is available and configured, otherwise false.

code: virtual bool CanCompileBinaryShaders() const


description:
Can this shader format strip shader code for packaging in a shader library?
True if and only if the format can strip extraneous data from shaders to be included in a shared library, otherwise false.

code: virtual bool CanStripShaderCode ( bool const bNativeFormat ) const


description: Compile the specified preprocessed shader; only called if SupportsIndependentPreprocessing returns true

code: virtual void CompilePreprocessedShader ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, const [FShaderPreprocessOutput](API\Runtime\RenderCore\FShaderPreprocessOutput) & PreprocessOutput, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & Output, const [FString](API\Runtime\Core\Containers\FString) & WorkingDirectory ) const


description: Compile the specified preprocessed shaders; only called if SupportsIndependentPreprocessing returns true, and the call to RequiresSecondaryCompile given the first preprocess output also returns true. The shader system will pack these outputs together in the following format: [int32 key][uint32 primary length][uint32 secondary length][full primary shader code][full secondary shader code] where "key" is the return value of the GetPackedShaderKey function (this should also be implemented by any backends which require secondary compilation and is used by the RHI to differentiate packed shader code from single shaders)

code: virtual void CompilePreprocessedShader ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, const [FShaderPreprocessOutput](API\Runtime\RenderCore\FShaderPreprocessOutput) & PrimaryPreprocessOutput, const [FShaderPreprocessOutput](API\Runtime\RenderCore\FShaderPreprocessOutput) & SecondaryPreprocessOutput, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & PrimaryOutput, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & SecondaryOutput, const [FString](API\Runtime\Core\Containers\FString) & WorkingDirectory ) const


description: Compile the specified shader. Only called if SupportsIndependentPreprocessing returns false.

code: virtual void CompileShader ( [FName](API\Runtime\Core\UObject\FName) Format, const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & Output, const [FString](API\Runtime\Core\Containers\FString) & WorkingDirectory ) const


description:
Create a format specific archive for precompiled shader code.
true if the archive was created

code: virtual bool CreateShaderArchive ( [FString](API\Runtime\Core\Containers\FString) const & LibraryName, [FName](API\Runtime\Core\UObject\FName) ShaderFormatAndShaderPlatformName, const [FString](API\Runtime\Core\Containers\FString) & WorkingDirectory, const [FString](API\Runtime\Core\Containers\FString) & OutputDir, const [FString](API\Runtime\Core\Containers\FString) & DebugOutputDir, const [FSerializedShaderArchive](API\Runtime\RenderCore\FSerializedShaderArchive) & SerializedShaders, const [TArray](API\Runtime\Core\Containers\TArray)< [TArray](API\Runtime\Core\Containers\TArray)< uint8 >> & ShaderCode, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > * OutputFiles ) const


description: Virtual function that can be implemented by backends which require secondary compilation to specify a unique "key" identifier for the packing scheme (for validation in the runtime at load). see RequiresSecondaryCompile and the overloads of CompilePreprocessedShader for additional details.

code: virtual int32 GetPackedShaderKey() const


description:
Returns name of directory with platform specific shaders.
Name of directory with platform specific shaders.

code: const TCHAR * GetPlatformIncludeDirectory() const


description: Gets the list of supported formats.

code: void GetSupportedFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFormats ) const


description:
Gets the current version of the specified shader format.
Version number.

code: uint32 GetVersion ( [FName](API\Runtime\Core\UObject\FName) Format ) const


description: Called before a shader is compiled to allow the platform shader format to modify the shader compiler input, e.g. by adding console variable values relevant to shader compilation on that platform.

code: virtual void ModifyShaderCompilerInput ( [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input ) const


description: Called at the end of a cook to free resources and finalize artifacts created during the cook.

code: virtual void NotifyShaderCompilersShutdown ( [FName](API\Runtime\Core\UObject\FName) Format ) const


description: Called when a shader resource is cooked, so the shader format can perform platform-specific operations on the debug data. Does nothing on platforms that make no use of the platform debug data.

code: virtual void NotifyShaderCompiled ( const TConstArrayView< uint8 > & PlatformDebugData, [FName](API\Runtime\Core\UObject\FName) Format ) const


description: Implement to output debug info for a single compile job; only called if SupportsIndependentPreprocessing returns true. This will be called for all jobs (including those found in the job cache) but only if debug info is enabled for the job. Note that any debug info output in CompilePreprocessedShader will only be done for the job that actually executes the compile step, as such any debug outputs that are desirable for all jobs should be written by this function. A BaseShaderFormat implementation is provided in ShaderCompilerCommon which dumps preprocessed and stripped USFs along with the hash of the shader code in an OutputHash.txt file; if no additional custom debug output is required the shader format can inherit from FBaseShaderFormat instead ofIShaderFormat.

code: virtual void OutputDebugData ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, const [FShaderPreprocessOutput](API\Runtime\RenderCore\FShaderPreprocessOutput) & PreprocessOutput, const [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & Output ) const


description: Implement to output debug info for the case where a secondary preprocessed shader was created. As with the dual-output version of CompilePreprocessedShader this is provided so shader formats can statically distinguish the single and dual output cases. Note that BaseShaderFormat does not provide an implementation of this so it needs to be explicitly implemented by backends which require secondary compilation, even if inheriting from FBaseShaderFormat.

code: virtual void OutputDebugData ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, const [FShaderPreprocessOutput](API\Runtime\RenderCore\FShaderPreprocessOutput) & PreprocessOutput, const [FShaderPreprocessOutput](API\Runtime\RenderCore\FShaderPreprocessOutput) & SecondaryPreprocessOutput, const [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & Output, const [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & SecondaryOutput ) const


description: Predicate which should return true if a second preprocess & compilation is required given the initial preprocess output. Only called if SupportsIndependentPreprocessing returns true. This is generally be determined by analyzing the directives on the given preprocess output (which are set by the presence of UESHADERMETADATA directives in the original source), though other conditions are possible and up to the implementation. In the event this returns true, PreprocessShader will be called an additional time, with the bIsSecondary field on theFShaderPreprocessOutputset to true, and the overload of CompilePreprocessedShader taking twoFShaderPreprocessOutputand twoFShaderCompilerOutputobjects will be called instead of the single object variants. Note that this is done instead of calling the single object variant twice so shader formats can statically distinguish primary compilation in a dual-compile case from the single-compile case.

code: virtual bool RequiresSecondaryCompile ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, const [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & Environment, const [FShaderPreprocessOutput](API\Runtime\RenderCore\FShaderPreprocessOutput) & PreprocessOutput ) const


description: Executes all shader preprocessing steps; only called if SupportsIndependentPreprocessing returns true

code: virtual bool PreprocessShader ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, const [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & Environment, [FShaderPreprocessOutput](API\Runtime\RenderCore\FShaderPreprocessOutput) & PreprocessOutput ) const


description:
Strips the shader bytecode provided of any unnecessary optional data elements when archiving shaders into the shared library.
True if the format has successfully stripped the extraneous data from shaders, otherwise false

code: virtual bool StripShaderCode ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Code, [FString](API\Runtime\Core\Containers\FString) const & DebugOutputDir, bool const bNative ) const


description: Return true if preprocessing for this format can be executed independent of compilation (i.e. the format has an implementation of the PreprocessShader function).

code: virtual bool SupportsIndependentPreprocessing() const


description:
Whether this shader format supports a format-specific archive for precompiled shader code.
true if shader archives are supported, false otherwise.

code: virtual bool SupportsShaderArchives() const


description:
Can the shader compiler use the HLSLcc library when compiling shaders
True if the shader compiler can use the HLSLcc library when compiling shaders, otherwise false.

code: virtual bool UsesHLSLcc ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input ) const


description: Virtual destructor.

code: virtual ~IShaderFormat()


description:
Gets the shader format.
The shader format interface.


className: IShaderFormat

description: IShaderFormat, shader pre-compilation abstraction

code: class IShaderFormat


description: Virtual destructor.

code: ~IShaderFormatModule()


className: IShaderFormatModule

description: Interface for shader format modules.

code: class IShaderFormatModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: OpenSocket

code: virtual void CloseConnection ( [ITargetDeviceSocketPtr](API\Developer\TargetPlatform\Interfaces\ITargetDeviceSocketPtr) Socket )


description:
Connect to the physical device.
true if the device is connected, false otherwise.

code: bool Connect()


description:
This will route device logs into specified OutputDevice until connection to device is alive
Valid router object for devices that support output routing

code: virtual [ITargetDeviceOutputPtr](API\Developer\TargetPlatform\Interfaces\ITargetDeviceOutputPtr) CreateDeviceOutputRouter ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) * Output ) const


description: Disconnect from the physical device.

code: void Disconnect()


description: Execute console command on the device

code: virtual void ExecuteConsoleCommand ( const [FString](API\Runtime\Core\Containers\FString) & ExecCommand ) const


description:
Get the "All devices" default variant
"All devices" default variant.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetAllDevicesDefaultVariant() const


description:
Get the "All devices" name
"All devices" name.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetAllDevicesName() const


description:
Gets the device connection type.
Device connection type.


description:
Gets the device type.
Device type.


description: GetName


description:
Gets the device model identifier.
ModelId.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetModelId() const


description: GetId


description:
Gets the name of the operating system running on this device.
Operating system name.


description:
Gets the device OS Version.
OSVersion.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetOSVersion() const


description:
Creates a snapshot of processes currently running on the device.
The number of returned processes.

code: int32 GetProcessSnapshot ( [TArray](API\Runtime\Core\Containers\TArray)< [FTargetDeviceProcessInfo](API\Developer\TargetPlatform\Interfaces\FTargetDeviceProcessInfo) > & OutProcessInfos )


description:
Creates a snapshot of processes currently running on the device.
True if retrieving a process snapshot is supported

code: virtual bool GetProcessSnapshotAsync ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [TArray](API\Runtime\Core\Containers\TArray)< [FTargetDeviceProcessInfo](API\Developer\TargetPlatform\Interfaces\FTargetDeviceProcessInfo) > &)> CompleteHandler )


description: Gets the TargetPlatform that this device belongs to.

code: const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) & GetTargetPlatform() const


description:
Get credentials for the user account to use on the device
true on success, false if not supported.

code: bool GetUserCredentials ( [FString](API\Runtime\Core\Containers\FString) & OutUserName, [FString](API\Runtime\Core\Containers\FString) & OutUserPassword )


description:
This is true for most platforms by default, but may be false for mobile platforms
true if this this device is authorized for launch

code: virtual bool IsAuthorized() const


description:
Checks whether this device is connected.
true if the device is connected, false otherwise.

code: bool IsConnected()


description:
Note that not all platforms may have a notion of default devices.
true if this is the default device, false otherwise.

code: bool IsDefault() const


description:
Get the "All devices" flag for the platform
true if the platform has an "All devices" proxy.

code: virtual bool IsPlatformAggregated() const


description:
Checks if connections using the given ProtocolIndex are available for this device at the moment. If this function returns true, it means that OpenConnection should succeed and communication with a game running on the target should be possible.
True if the protocol is available and we can connect to the device, false otherwise.

code: virtual bool IsProtocolAvailable ( uint32 ProtocolIndex ) const


description: ITargetDeviceSocket::Connected

code: virtual [ITargetDeviceSocketPtr](API\Developer\TargetPlatform\Interfaces\ITargetDeviceSocketPtr) OpenConnection ( uint32 ProtocolIndex )


description:
Powers off the device.
true if the device will be powered off, false otherwise.

code: bool PowerOff ( bool Force )


description:
Powers on the device.
true if the device will be powered on, false otherwise.

code: bool PowerOn()


description:
Reboot the device.
true if the reboot was successful from the perspective of the PC .

code: bool Reboot ( bool bReconnect )


description: Execute console command on the device to reload the global shader map

code: virtual void ReloadGlobalShadersMap ( const [FString](API\Runtime\Core\Containers\FString) & GlobalShaderMapDirectory ) const


description: Set credentials for the user account to use on the device

code: void SetUserCredentials ( const [FString](API\Runtime\Core\Containers\FString) & UserName, const [FString](API\Runtime\Core\Containers\FString) & UserPassword )


description:
Checks whether the target device supports the specified feature.
true if the feature is supported, false otherwise.

code: bool SupportsFeature ( [ETargetDeviceFeatures](API\Developer\TargetPlatform\Interfaces\ETargetDeviceFeatures) Feature ) const


description: Cancel the application running on the device

code: virtual bool TerminateLaunchedProcess ( const [FString](API\Runtime\Core\Containers\FString) & ProcessIdentifier )


description:
Terminates a process that was launched on the device using the Launch() or Run() methods.
true if the process was terminated, false otherwise.

code: bool TerminateProcess ( const int64 ProcessId )


className: ITargetDevice

description: Interface for target devices.

code: class ITargetDevice


description: Virtual destructor.

code: virtual ~ITargetDevice()


description: Virtual destructor.

code: virtual ~ITargetDeviceOutput()


className: ITargetDeviceOutput

description: Interface for target device output log reader.

code: class ITargetDeviceOutput


className: ITargetDeviceOutputPtr

description: Type definition for shared pointers to instances ofITargetDeviceOutput.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ITargetDeviceOutput](API\Developer\TargetPlatform\Interfaces\ITargetDeviceOutput), ESPMode::ThreadSafe > ITargetDeviceOutputPtr


className: ITargetDevicePtr

description: Type definition for shared pointers to instances ofITargetDevice.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ITargetDevice](API\Developer\TargetPlatform\Interfaces\ITargetDevice), ESPMode::ThreadSafe > ITargetDevicePtr


className: ITargetDeviceRef

description: Type definition for shared references to instances ofITargetDevice.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ITargetDevice](API\Developer\TargetPlatform\Interfaces\ITargetDevice), ESPMode::ThreadSafe > ITargetDeviceRef


description: Returns true if this socket is actually connected to another peer and is ready to send/receive data.

code: bool Connected() const


description: IHostDevice::CloseConnection

code: bool Receive ( void * Data, uint64 BytesToReceive )


description: IHostDevice::CloseConnection

code: bool Send ( const void * Data, uint64 BytesToSend )


description: Virtual destructor.

code: virtual ~ITargetDeviceSocket()


className: ITargetDeviceSocket

description: This interface provides an abstraction for communicating with processes running on the target.

code: class ITargetDeviceSocket


className: ITargetDeviceSocketPtr

description: Type definition for shared pointers to instances ofIPlatformHostSocket.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDeviceSocket](API\Developer\TargetPlatform\Interfaces\ITargetDeviceSocket), ESPMode::ThreadSafe > ITargetDeviceSocketPtr


className: ITargetDeviceSocketRef

description: Type definition for shared references to instances ofIPlatformHostSocket.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITargetDeviceSocket](API\Developer\TargetPlatform\Interfaces\ITargetDeviceSocket), ESPMode::ThreadSafe > ITargetDeviceSocketRef


className: ITargetDeviceWeakPtr

description: Type definition for weak pointers to instances ofITargetDevice.

code: typedef [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< class [ITargetDevice](API\Developer\TargetPlatform\Interfaces\ITargetDevice), ESPMode::ThreadSafe > ITargetDeviceWeakPtr


description:
Add a target device by name.
true if the device was added, false otherwise.

code: bool AddDevice ( const [FString](API\Runtime\Core\Containers\FString) & DeviceName, bool bDefault )


description:
Add a target device.
true if the device was added, false otherwise.

code: bool AddDevice ( const [FString](API\Runtime\Core\Containers\FString) & DeviceId, const [FString](API\Runtime\Core\Containers\FString) & DeviceUserFriendlyName, const [FString](API\Runtime\Core\Containers\FString) & Username, const [FString](API\Runtime\Core\Containers\FString) & Password, bool bDefault )


description:
Checks whether this platform will allow development objects to be cooked. This is separate from AllowsEditorObjects because cooked editors can be shipped with editor objects but still need to remove development assets.
true if this platform allows development objects to be cooked, false otherwise.

code: bool AllowsDevelopmentObjects() const


description:
Checks whether this platform will allow editor objects to be cooked, as opposed to editoronly properties. This will allow a target platform to cook editoronly objects, but as if they were being cooked for a client. This is useful for a cooked editor scenario, where every pacakge is cooked, editor and game alike.
true if this platform allows editor objects to be cooked, false otherwise.

code: bool AllowsEditorObjects() const


code: static int32 AssignPlatformOrdinal ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) & Platform )


description:
Checks whether this platform supports shader compilation over XGE interface.
true if this platform can distribute shader compilation threads with XGE.


description:
Checks whether the platform's build requirements are met so that we can do things like package for the platform.
A mask of ETargetPlatformReadyStatus flags to indicate missing requirements, or 0 if all requirements are met.

code: int32 CheckRequirements ( bool bProjectHasCode, EBuildConfiguration Configuration, bool bRequiresAssetNativization, [FString](API\Runtime\Core\Containers\FString) & OutTutorialPath, [FString](API\Runtime\Core\Containers\FString) & OutDocumentationPath, [FText](API\Runtime\Core\Internationalization\FText) & CustomizedLogMessage ) const


description: Gets the name of the device profile to use when cooking this TargetPlatform


description: Copy a file to the target

code: bool CopyFileToTarget ( const [FString](API\Runtime\Core\Containers\FString) & DeviceId, const [FString](API\Runtime\Core\Containers\FString) & HostFilename, const [FString](API\Runtime\Core\Containers\FString) & TargetFilename, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & CustomPlatformData )


description: PlatformName


description: Enables/Disable the device check

code: void EnableDeviceCheck ( bool OnOff )


className: FOnTargetDeviceDiscovered

description: Gets an event delegate that is executed when a new target device has been discovered.

code: class FOnTargetDeviceDiscovered : public TBaseMulticastDelegate_OneParam< void, ITargetDeviceRef >


className: FOnTargetDeviceLost

description: Gets an event delegate that is executed when a target device has been lost, i.e. disconnected or timed out.

code: class FOnTargetDeviceLost : public TBaseMulticastDelegate_OneParam< void, ITargetDeviceRef >


description: Gets whether the platform will use SH2 instead of SH3 for sky irradiance.

code: bool ForcesSimpleSkyDiffuse() const


description:
Generates a platform specific asset manifest given an array ofFAssetData.
true if the manifest was successfully generated, or if the platform doesn't need a manifest .

code: bool GenerateStreamingInstallManifest ( const [TMultiMap](API\Runtime\Core\Containers\TMultiMap)< [FString](API\Runtime\Core\Containers\FString), int32 > & PakchunkMap, const [TSet](API\Runtime\Core\Containers\TSet)< int32 > & PakchunkIndicesInUse ) const


description: Returns all discoverable physical devices.

code: void GetAllDevices ( [TArray](API\Runtime\Core\Containers\TArray)< [ITargetDevicePtr](API\Developer\TargetPlatform\Interfaces\ITargetDevicePtr) > & OutDevices ) const


description: Gets the shader formats this platform can use.

code: void GetAllPossibleShaderFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFormats ) const


description: Gets the shader formats that have been selected for this target platform

code: void GetAllTargetedShaderFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFormats ) const


description: Project settings to check to determine if a build should occur

code: void GetBuildProjectSettingKeys ( [FString](API\Runtime\Core\Containers\FString) & OutSection, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InBoolKeys, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InIntKeys, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InStringKeys ) const