FTargetPlatformBase

Base class for target platforms.

Unreal Engine C++ API Reference > Developer > TargetPlatform > Common

Inheritance Hierarchy

References

   
Module TargetPlatform
Header /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h
Include #include "Common/TargetPlatformBase.h"

Syntax

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

Remarks

Base class for target platforms.

Variables

Type Name Description
const PlatformI... PlatformInfo Information about this platform
int32 PlatformOrdinal  

Constructors

Type Name Description
  FTargetPlatformBase ( const PlatformInfo::FTargetPlatform... )  

Functions

Type Name Description
void AddDependencySCArrayHelper ( TArray< FString >& OutDependencies, const FString& DependencyRelativeP... ) Helper method to fill a dependencies array for the shader compiler with absolute paths, passing a relative path to the Engine as the parameter.
void AppendAnalyticsEventConfigArray ( TArray< struct FAnalyticsEventAttri..., const TCHAR* ConfigSection, const TCHAR* ConfigKey, const FString& IniFileName, const TCHAR* AnalyticsKeyNameO... )  
void AppendAnalyticsEventConfigBool ( TArray< struct FAnalyticsEventAttri..., const TCHAR* ConfigSection, const TCHAR* ConfigKey, const FString& IniFileName, const TCHAR* AnalyticsKeyNameO... ) Analytics helper functions
void AppendAnalyticsEventConfigFloat ( TArray< struct FAnalyticsEventAttri..., const TCHAR* ConfigSection, const TCHAR* ConfigKey, const FString& IniFileName, const TCHAR* AnalyticsKeyNameO... )  
void AppendAnalyticsEventConfigInt ( TArray< struct FAnalyticsEventAttri..., const TCHAR* ConfigSection, const TCHAR* ConfigKey, const FString& IniFileName, const TCHAR* AnalyticsKeyNameO... )  
void AppendAnalyticsEventConfigString ( TArray< struct FAnalyticsEventAttri..., const TCHAR* ConfigSection, const TCHAR* ConfigKey, const FString& IniFileName, const TCHAR* AnalyticsKeyNameO... )  
const Audio:... GetAudioFormatSettings ()  

Overridden from ITargetPlatform

Type Name Description
bool AddDevice ( const FString& DeviceName, bool bDefault ) Add a target device by name.
bool AddDevice ( const FString& DeviceId, const FString& DeviceUserFriendlyN..., const FString& Username, const FString& Password, bool bDefault ) Add a target device.
bool AllowsDevelopmentObjects () Checks whether this platform will allow development objects to be cooked.
bool AllowsEditorObjects () Checks whether this platform will allow editor objects to be cooked, as opposed to editoronly properties.
bool CanSupportRemoteShaderCompile () Checks whether this platform supports shader compilation over XGE interface.
int32 CheckRequirements ( bool bProjectHasCode, EBuildConfiguration Configuration, bool bRequiresAssetNativization, FString& OutTutorialPath, FString& OutDocumentationPath, FText& CustomizedLogMessage ) Checks whether the platform's build requirements are met so that we can do things like package for the platform.
bool CopyFileToTarget ( const FString& DeviceId, const FString& HostFilename, const FString& TargetFilename, const TMap< FString, FString >& Cu... ) Copy a file to the target
FText DisplayName () Gets the platform's display name.
bool ForcesSimpleSkyDiffuse () Gets whether the platform will use SH2 instead of SH3 for sky irradiance.
void GetBuildProjectSettingKeys ( FString& OutSection, TArray< FString >& InBoolKeys, TArray< FString >& InIntKeys, TArray< FString >& InStringKeys ) Project settings to check to determine if a build should occur
FConfigCache... GetConfigSystem () Returns the config system object usable by this TargetPlatform. It should not be modified in anyway
TSharedPtr< ... GetCustomWidgetCreator () Returns custom DeviceManager widget creator for this platform
float GetDownSampleMeshDistanceFieldDivider () Gets down sample mesh distance field divider.
void GetExtraPackagesToCook ( TArray< FName >& PackageNames ) Gets a list of package names to cook when cooking this platform
int32 GetHeightFogModeForOpaque () Gets an integer representing the height fog mode for opaque materials on a platform.
const FDataD... GetPlatformInfo () Returns the information about the platform as a whole
int32 GetPlatformOrdinal () Get unique integer identifier for this platform.
void GetPlatformSpecificProjectAnalytics ( TArray< struct FAnalyticsEventAttri... ) Gather per-project cook/package analytics
void GetRayTracingShaderFormats ( TArray< FName >& OutFormats ) Gets the shader formats that support ray tracing for this target platform.
void GetShaderCompilerDependencies ( TArray< FString >& OutDependencies ) Provide platform specific file dependency patterns for SN-DBS shader compilation.
EOfflineBVHM... GetStaticMeshOfflineBVHMode () Gets static mesh offline BVH mode
const Platfo... GetTargetPlatformInfo () Returns the information about this target platform
float GetVariantPriority () Gets the variant priority of this platform
bool InitializeHostPlatform () Initializes the host platform to support target devices (may be called multiple times after an SDK is installed while running)
bool IsEnabledForPlugin ( const IPlugin& Plugin ) Checks whether this platform is enabled for the given plugin in the currently active project.
bool IsSdkInstalled ( bool bProjectHasCode, FString& OutDocumentationPath ) Checks whether the platform's SDK requirements are met so that we can do things like package for the platform
bool PackageBuild ( const FString& InPackgeDirectory ) Package a build for the given platform
bool RequiresTempTarget ( bool bProjectHasCode, EBuildConfiguration Configuration, bool bRequiresAssetNativization, FText& OutReason ) Checks whether the current project needs a temporary .target.cs file to be packaged as a code project.
bool SendLowerCaseFilePaths () Whether or not to send all lower-case filepaths when connecting over a fileserver connection.
bool ShouldExpandTo32Bit ( const uint16* Indices, const int32 NumIndices ) Returns wheter or not this 16bit index buffer should be promoted to 32bit
bool SupportsValueForType ( FName SupportedType, FName RequiredSupportedValue ) Checks whether the target platform supports the specified value for the specified type of support
bool SupportsVariants () Returns true if the platform is part of a family of variants
bool UsesASTCHDR () Gets whether the platform uses ASTC HDR
bool UsesDBuffer () Gets whether the platform should use DBuffer for decals.
bool UsesDistanceFields () Gets whether the platform will use distance fields.
bool UsesForwardShading () Gets whether the platform should use forward shading or not.
bool UsesMobileAmbientOcclusion () Gets whether the platform uses Mobile AO
bool UsesRayTracing () Gets whether the platform will use ray tracing.
bool UsesSelectiveBasePassOutputs () Gets whether the platform will use selective outputs in the base pass shaders.
bool VelocityEncodeDepth () Gets whether the platform will encode depth velocity.

Deprecated Functions

Type Name Description
bool UsesBasePassVelocity () Use IsUsingBasePassVelocity(EShaderPlatform Platform) in renderutils that will uses FShaderPlatformCachedIniValue to retrieve the cvar value per platform.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library