Navigation
API > API/Developer > API/Developer/TargetPlatform
Redirect everything to TPS or TPC.
| Name | FTargetPlatformMerged |
| Type | class |
| Header File | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h |
| Include Path | #include "Common/TargetPlatformBase.h" |
Syntax
class FTargetPlatformMerged : public ITargetPlatform
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTargetPlatformMerged
(
ITargetPlatformSettings* InTargetPlatformSettings, |
Common/TargetPlatformBase.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FTargetPlatformMerged() |
Virtual destructor. | Common/TargetPlatformBase.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| TargetPlatformControls | ITargetPlatformControls * | Common/TargetPlatformBase.h | ||
| TargetPlatformSettings | ITargetPlatformSettings * | Common/TargetPlatformBase.h |
Functions
Public
Overridden from ITargetPlatformSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool ForcesSimpleSkyDiffuse() |
Gets whether the platform will use SH2 instead of SH3 for sky irradiance. | Common/TargetPlatformBase.h | |
| Gets the shader formats this platform can use. | Common/TargetPlatformBase.h | ||
| Gets the shader formats that have been selected for this target platform | Common/TargetPlatformBase.h | ||
virtual FConfigCacheIni * GetConfigSystem() |
Returns the config system object usable by this TargetPlatform. It should not be modified in anyway | Common/TargetPlatformBase.h | |
virtual float GetDownSampleMeshDistanceFieldDivider() |
Gets down sample mesh distance field divider. | Common/TargetPlatformBase.h | |
virtual FName GetFallbackASTCHDR() |
Gets the fallback format when ASTC HDR is not supported | Common/TargetPlatformBase.h | |
virtual int32 GetHeightFogModeForOpaque() |
Gets an integer representing the height fog mode for opaque materials on a platform. | Common/TargetPlatformBase.h | |
virtual FString GetHostArchitecture() |
Get the host architectures for the target platform, if any | Common/TargetPlatformBase.h | |
| Get the possible architectures for the target platform | Common/TargetPlatformBase.h | ||
virtual ERayTracingRuntimeMode GetRayTracingMode() |
Gets ray tracing runtime mode (disabled/inline/hit-lighting). | Common/TargetPlatformBase.h | |
| Gets the shader formats that support ray tracing for this target platform. | Common/TargetPlatformBase.h | ||
virtual EOfflineBVHMode GetSkeletalMeshOfflineBVHMode() |
Gets skeletal mesh offline BVH mode | Common/TargetPlatformBase.h | |
virtual bool GetStaticMeshOfflineBVHCompression() |
Gets whether the platform will use compression for static mesh offline BVH. | Common/TargetPlatformBase.h | |
virtual EOfflineBVHMode GetStaticMeshOfflineBVHMode() |
Gets static mesh offline BVH mode | Common/TargetPlatformBase.h | |
virtual uint32 GetSupportedHardwareMask () |
Gets a platform-dependent bitfield describing which hardware generations are supported. | Common/TargetPlatformBase.h | |
virtual FString IniPlatformName () |
Gets the platform's INI name (so an offline tool can load the INI for the given target platform). | Common/TargetPlatformBase.h | |
virtual bool ShouldStripNaniteFallbackMeshes() |
Gets whether Nanite fallback meshes should be stripped from cooked builds for the platform. | Common/TargetPlatformBase.h | |
virtual bool SupportsFeature
(
ETargetPlatformFeatures Feature |
Checks whether the target platform supports the specified feature. | Common/TargetPlatformBase.h | |
| Checks whether the target platform supports the specified value for the specified type of support | Common/TargetPlatformBase.h | ||
virtual bool UsesASTCHDR() |
Gets whether the platform uses ASTC HDR | Common/TargetPlatformBase.h | |
virtual bool UsesBasePassVelocity() |
Gets whether the platform should output velocity in the base pass. | Common/TargetPlatformBase.h | |
virtual bool UsesDBuffer() |
Gets whether the platform should use DBuffer for decals. | Common/TargetPlatformBase.h | |
virtual bool UsesDistanceFields() |
Gets whether the platform will use distance fields. | Common/TargetPlatformBase.h | |
virtual bool UsesForwardShading() |
Gets whether the platform should use forward shading or not. | Common/TargetPlatformBase.h | |
virtual bool UsesMobileDBuffer() |
Gets whether the platform should use DBuffer for decals when using the mobile renderer. | Common/TargetPlatformBase.h | |
virtual bool UsesRayTracing() |
Gets whether the platform will use ray tracing. | Common/TargetPlatformBase.h | |
virtual bool UsesSelectiveBasePassOutputs() |
Gets whether the platform will use selective outputs in the base pass shaders. | Common/TargetPlatformBase.h | |
virtual bool VelocityEncodeDepth() |
Gets whether the platform will encode depth velocity. | Common/TargetPlatformBase.h |
Overridden from ITargetPlatformControls
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Add a target device by name. | Common/TargetPlatformBase.h | ||
| Add a target device. | Common/TargetPlatformBase.h | ||
virtual bool AllowsDevelopmentObjects () |
Checks whether this platform will allow development objects to be cooked. | Common/TargetPlatformBase.h | |
virtual bool AllowsEditorObjects () |
Checks whether this platform will allow editor objects to be cooked, as opposed to editoronly properties. | Common/TargetPlatformBase.h | |
virtual bool CanSupportRemoteShaderCompile() |
Checks whether this platform supports shader compilation over XGE interface. | Common/TargetPlatformBase.h | |
virtual int32 CheckRequirements
(
bool bProjectHasCode, |
Checks whether the platform's build requirements are met so that we can do things like package for the platform. | Common/TargetPlatformBase.h | |
virtual FString CookingDeviceProfileName() |
Gets the name of the device profile to use when cooking this TargetPlatform | Common/TargetPlatformBase.h | |
| Copy a file to the target | Common/TargetPlatformBase.h | ||
virtual FText DisplayName () |
Gets the platform's display name. | Common/TargetPlatformBase.h | |
virtual void EnableDeviceCheck
(
bool OnOff |
Enables/Disable the device check | Common/TargetPlatformBase.h | |
virtual bool GenerateStreamingInstallManifest
(
const TMultiMap< FString, int32 >& PakchunkMap, |
Generates a platform specific asset manifest given an array of FAssetData. | Common/TargetPlatformBase.h | |
virtual void GetAllDevices
(
TArray< ITargetDevicePtr >& OutDevices |
Returns all discoverable physical devices. | Common/TargetPlatformBase.h | |
| Project settings to check to determine if a build should occur | Common/TargetPlatformBase.h | ||
virtual TSharedPtr< IDeviceManagerCustomPlatformWidgetCreator > GetCustomWidgetCreator() |
Returns custom DeviceManager widget creator for this platform | Common/TargetPlatformBase.h | |
virtual ITargetDevicePtr GetDefaultDevice() |
Gets the default device.Note that not all platforms may have a notion of default devices. | Common/TargetPlatformBase.h | |
virtual ITargetDevicePtr GetDevice
(
const FTargetDeviceId& DeviceId |
Gets an interface to the specified device. | Common/TargetPlatformBase.h | |
| Gets a list of package names to cook when cooking this platform | Common/TargetPlatformBase.h | ||
virtual int64 GetMemoryMappingAlignment() |
Gets the alignment of memory mapping for this platform, typically the page size. | Common/TargetPlatformBase.h | |
virtual const FDataDrivenPlatformInfo & GetPlatformInfo() |
Returns the information about the platform as a whole | Common/TargetPlatformBase.h | |
virtual int32 GetPlatformOrdinal () |
Get unique integer identifier for this platform. | Common/TargetPlatformBase.h | |
virtual void GetPlatformSpecificProjectAnalytics
(
TArray< struct FAnalyticsEventAttribute >& AnalyticsParamArray |
Gather per-project cook/package analytics | Common/TargetPlatformBase.h | |
virtual EBuildTargetType GetRuntimePlatformType () |
Return the TargetType this platform uses at runtime. | Common/TargetPlatformBase.h | |
| Provide platform specific file dependency patterns for SN-DBS shader compilation. | Common/TargetPlatformBase.h | ||
virtual const PlatformInfo::FTargetPlatformInfo & GetTargetPlatformInfo() |
Returns the information about this target platform | Common/TargetPlatformBase.h | |
virtual float GetVariantPriority() |
Gets the variant priority of this platform | Common/TargetPlatformBase.h | |
virtual FName GetZlibReplacementFormat() |
Gets a new compression format to use in place of Zlib. This should be rarely implemented | Common/TargetPlatformBase.h | |
virtual bool HasEditorOnlyData() |
Checks whether this platform has only editor data (typically desktop platforms). | Common/TargetPlatformBase.h | |
virtual bool HasSecurePackageFormat() |
Checks whether this platform has a secure shippable package format, and therefore doesn't need any encryption or signing support | Common/TargetPlatformBase.h | |
virtual void InitializeForCook () |
Hook called when a TargetPlatform is selected for cooking. | Common/TargetPlatformBase.h | |
virtual bool InitializeHostPlatform() |
Initializes the host platform to support target devices (may be called multiple times after an SDK is installed while running) | Common/TargetPlatformBase.h | |
virtual bool IsClientOnly() |
Checks whether this platform is only a client (and must connect to a server to run). | Common/TargetPlatformBase.h | |
virtual bool IsEnabledForPlugin
(
const IPlugin& Plugin |
Checks whether this platform is enabled for the given plugin in the currently active project. | Common/TargetPlatformBase.h | |
virtual bool IsLittleEndian() |
Checks whether this platform is little endian. | Common/TargetPlatformBase.h | |
virtual bool IsRunningPlatform () |
Checks whether this platform is the platform that's currently running. | Common/TargetPlatformBase.h | |
virtual bool IsSdkInstalled
(
bool bProjectHasCode, |
Checks whether the platform's SDK requirements are met so that we can do things like package for the platform | Common/TargetPlatformBase.h | |
virtual bool IsServerOnly() |
Checks whether this platform is only a server. | Common/TargetPlatformBase.h | |
virtual bool PackageBuild
(
const FString& InPackgeDirectory |
Package a build for the given platform | Common/TargetPlatformBase.h | |
virtual FString PlatformName () |
Returns the name of this platform | Common/TargetPlatformBase.h | |
virtual void RefreshAllDevices() |
Manually refresh the devices | Common/TargetPlatformBase.h | |
virtual bool RequiresCookedData() |
Checks whether this platform requires cooked data (typically console platforms). | Common/TargetPlatformBase.h | |
virtual bool RequiresOriginalReleaseVersionForPatch() |
Checks whether this platform requires the originally released version (in addition to the previously released version) to create a patch | Common/TargetPlatformBase.h | |
virtual bool RequiresTempTarget
(
bool bProjectHasCode, |
Checks whether the current project needs a temporary .target.cs file to be packaged as a code project. | Common/TargetPlatformBase.h | |
virtual EPlatformAuthentication RequiresUserCredentials() |
Checks whether this platform requires user credentials (typically server platforms). | Common/TargetPlatformBase.h | |
virtual bool SendLowerCaseFilePaths() |
Whether or not to send all lower-case filepaths when connecting over a fileserver connection. | Common/TargetPlatformBase.h | |
virtual bool ShouldExpandTo32Bit
(
const uint16* Indices, |
Returns wheter or not this 16bit index buffer should be promoted to 32bit | Common/TargetPlatformBase.h | |
virtual bool SupportsAutoSDK() |
Returns true if the platform supports the AutoSDK system | Common/TargetPlatformBase.h | |
virtual bool SupportsBuildTarget
(
EBuildTargetType TargetType |
Checks whether this platform supports the specified build target, i.e. Game or Editor. | Common/TargetPlatformBase.h | |
virtual bool SupportsVariants() |
Returns true if the platform is part of a family of variants | Common/TargetPlatformBase.h |