className
stringlengths 1
167
| headerPath
stringlengths 14
166
| description
stringlengths 0
1.62k
| module
stringlengths 0
76
| code
stringlengths 0
11.4k
| variables
listlengths 0
395
|
|---|---|---|---|---|---|
ITargetDeviceService::GetDevicePlatformDisplayName | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | Gets the display name of the platform of device that this service exposes.
The human readable platform name. | TargetDeviceServices | [FString](API\Runtime\Core\Containers\FString) GetDevicePlatformDisplayName() const | [] |
ITargetDeviceService::GetDevicePlatformName | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | Gets the name of the platform of device that this service exposes.
The platform name. | TargetDeviceServices | [FName](API\Runtime\Core\UObject\FName) GetDevicePlatformName() const | [] |
ITargetDeviceService::IsRunning | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | Checks whether the service is currently running.
true if the service is running, false otherwise. | TargetDeviceServices | bool IsRunning() const | [] |
ITargetDeviceService::IsShared | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | SetShared | TargetDeviceServices | bool IsShared() const | [] |
ITargetDeviceService::NumTargetDevices | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | Gets number of target devices.
number of target devices in this device service. | TargetDeviceServices | int32 NumTargetDevices() | [] |
ITargetDeviceService::RemoveTargetDevice | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | Removes a flavor from this device.
true if the service can start, false otherwise. | TargetDeviceServices | void RemoveTargetDevice ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDevice](API\Developer\TargetPlatform\Interfaces\ITargetDevice), ESPMode::ThreadSafe > InDevice ) | [] |
ITargetDeviceService::SetShared | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | IsShared | TargetDeviceServices | void SetShared ( bool InShared ) | [] |
ITargetDeviceService::Start | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | Stop | TargetDeviceServices | bool Start() | [] |
ITargetDeviceService::Stop | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | Stop | TargetDeviceServices | void Stop() | [] |
ITargetDeviceService::~ITargetDeviceService | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | Virtual destructor. | TargetDeviceServices | virtual ~ITargetDeviceService() | [] |
ITargetDeviceService | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | ITargetDeviceProxy | TargetDeviceServices | class ITargetDeviceService | [] |
ITargetDeviceServiceManager::AddStartupService | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceServiceManager.h | RemoveStartupService | TargetDeviceServices | bool AddStartupService ( const [FString](API\Runtime\Core\Containers\FString) & DeviceName ) | [] |
FOnTargetDeviceServiceAdded | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceServiceManager.h | Gets an event delegate that is executed when a target device service was added. | TargetDeviceServices | class FOnTargetDeviceServiceAdded : public TBaseMulticastDelegate_OneParam< void, const ITargetDeviceServiceRef & > | [] |
FOnTargetDeviceServiceRemoved | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceServiceManager.h | Gets an event delegate that is executed when a target device service was removed. | TargetDeviceServices | class FOnTargetDeviceServiceRemoved : public TBaseMulticastDelegate_OneParam< void, const ITargetDeviceServiceRef & > | [] |
ITargetDeviceServiceManager::GetServices | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceServiceManager.h | Gets the collection of target device services managed by this instance.
The number of services returned. | TargetDeviceServices | int32 GetServices ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDeviceService](API\Developer\TargetDeviceServices\ITargetDeviceService), ESPMode::ThreadSafe >> & OutServices ) | [] |
ITargetDeviceServiceManager::OnServiceAdded | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceServiceManager.h | TargetDeviceServices | [FOnTargetDeviceServiceAdded](API\Developer\TargetDeviceServices\ITargetDeviceServiceManager\FOnTargetDeviceS-) & OnServiceAdded() | [] |
|
ITargetDeviceServiceManager::OnServiceRemoved | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceServiceManager.h | TargetDeviceServices | [FOnTargetDeviceServiceRemoved](API\Developer\TargetDeviceServices\ITargetDeviceServiceManager\FOnTargetDeviceS-_1) & OnServiceRemoved() | [] |
|
ITargetDeviceServiceManager::RemoveStartupService | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceServiceManager.h | GetServices | TargetDeviceServices | void RemoveStartupService ( const [FString](API\Runtime\Core\Containers\FString) & DeviceName ) | [] |
ITargetDeviceServiceManager::~ITargetDeviceServiceManager | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceServiceManager.h | Virtual destructor. | TargetDeviceServices | virtual ~ITargetDeviceServiceManager() | [] |
ITargetDeviceServiceManager | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceServiceManager.h | Interface for target device service managers. | TargetDeviceServices | class ITargetDeviceServiceManager | [] |
ITargetDeviceServicePtr | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | Type definition for shared pointers to instances ofITargetDeviceService. | TargetDeviceServices | typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ITargetDeviceService](API\Developer\TargetDeviceServices\ITargetDeviceService), ESPMode::ThreadSafe > ITargetDeviceServicePtr | [] |
ITargetDeviceServiceRef | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | Type definition for shared references to instances ofITargetDeviceService. | TargetDeviceServices | typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ITargetDeviceService](API\Developer\TargetDeviceServices\ITargetDeviceService), ESPMode::ThreadSafe > ITargetDeviceServiceRef | [] |
ITargetDeviceServicesModule::GetDeviceProxyManager | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceServicesModule.h | GetDeviceServiceManager | TargetDeviceServices | [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITargetDeviceProxyManager](API\Developer\TargetDeviceServices\ITargetDeviceProxyManager) > GetDeviceProxyManager() | [] |
ITargetDeviceServicesModule::GetDeviceServiceManager | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceServicesModule.h | GetDeviceProxyManager | TargetDeviceServices | [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITargetDeviceServiceManager](API\Developer\TargetDeviceServices\ITargetDeviceServiceManager) > GetDeviceServiceManager() | [] |
ITargetDeviceServicesModule::~ITargetDeviceServicesModule | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceServicesModule.h | Virtual destructor. | TargetDeviceServices | virtual ~ITargetDeviceServicesModule() | [] |
ITargetDeviceServicesModule | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceServicesModule.h | Interface for target device services modules. | TargetDeviceServices | class ITargetDeviceServicesModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | [] |
FTargetPlatformBase::AddDependencySCArrayHelper | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Helper method to fill a dependencies array for the shader compiler with absolute paths, passing a relative path to the Engine as the parameter. | TargetPlatform | static void AddDependencySCArrayHelper ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutDependencies, const [FString](API\Runtime\Core\Containers\FString) & DependencyRelativePath ) | [] |
FTargetPlatformBase::AddDevice | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Add a target device by name.
true if the device was added, false otherwise. | TargetPlatform | virtual bool AddDevice ( const [FString](API\Runtime\Core\Containers\FString) & DeviceName, bool bDefault ) | [] |
FTargetPlatformBase::AddDevice | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Add a target device.
true if the device was added, false otherwise. | TargetPlatform | 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 ) | [] |
FTargetPlatformBase::AllowsDevelopmentObjects | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | 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. | TargetPlatform | virtual bool AllowsDevelopmentObjects() const | [] |
FTargetPlatformBase::AllowsEditorObjects | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | 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. | TargetPlatform | virtual bool AllowsEditorObjects() const | [] |
FTargetPlatformBase::AppendAnalyticsEventConfigBool | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Analytics helper functions | TargetPlatform | 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 ) | [] |
FTargetPlatformBase::AppendAnalyticsEventConfigInt | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | TargetPlatform | 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 ) | [] |
|
FTargetPlatformBase::AppendAnalyticsEventConfigFloat | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | TargetPlatform | 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 ) | [] |
|
FTargetPlatformBase::AppendAnalyticsEventConfigString | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | TargetPlatform | 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 ) | [] |
|
FTargetPlatformBase::AppendAnalyticsEventConfigArray | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | TargetPlatform | 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 ) | [] |
|
FTargetPlatformBase::CanSupportRemoteShaderCompile | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Checks whether this platform supports shader compilation over XGE interface.
true if this platform can distribute shader compilation threads with XGE. | TargetPlatform | virtual bool CanSupportRemoteShaderCompile() const | [] |
FTargetPlatformBase::CheckRequirements | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | 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. | TargetPlatform | 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 | [] |
FTargetPlatformBase::CopyFileToTarget | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Copy a file to the target | TargetPlatform | 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 ) | [] |
FTargetPlatformBase::DisplayName | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | PlatformName | TargetPlatform | virtual [FText](API\Runtime\Core\Internationalization\FText) DisplayName() const | [] |
FTargetPlatformBase::ForcesSimpleSkyDiffuse | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets whether the platform will use SH2 instead of SH3 for sky irradiance. | TargetPlatform | virtual bool ForcesSimpleSkyDiffuse() const | [] |
FTargetPlatformBase::GetAudioFormatSettings | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | TargetPlatform | const [Audio::FAudioFormatSettings](API\Runtime\Engine\Sound\FAudioFormatSettings) & GetAudioFormatSettings() const | [] |
|
FTargetPlatformBase::GetBuildProjectSettingKeys | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Project settings to check to determine if a build should occur | TargetPlatform | 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 | [] |
FTargetPlatformBase::GetConfigSystem | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Returns the config system object usable by this TargetPlatform. It should not be modified in anyway | TargetPlatform | virtual [FConfigCacheIni](API\Runtime\Core\Misc\FConfigCacheIni) * GetConfigSystem() const | [] |
FTargetPlatformBase::GetCustomWidgetCreator | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Returns custom DeviceManager widget creator for this platform | TargetPlatform | virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IDeviceManagerCustomPlatformWidgetCreator](API\Developer\TargetPlatform\Interfaces\IDeviceManagerCustomPlatformWidg-) > GetCustomWidgetCreator() const | [] |
FTargetPlatformBase::GetDownSampleMeshDistanceFieldDivider | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets down sample mesh distance field divider.
1 if platform does not need to downsample mesh distance fields | TargetPlatform | virtual float GetDownSampleMeshDistanceFieldDivider() const | [] |
FTargetPlatformBase::GetExtraPackagesToCook | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets a list of package names to cook when cooking this platform | TargetPlatform | virtual void GetExtraPackagesToCook ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & PackageNames ) const | [] |
FTargetPlatformBase::GetHeightFogModeForOpaque | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | 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. | TargetPlatform | virtual int32 GetHeightFogModeForOpaque() const | [] |
FTargetPlatformBase::GetPlatformInfo | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Returns the information about the platform as a whole | TargetPlatform | virtual const [FDataDrivenPlatformInfo](API\Runtime\Core\Misc\FDataDrivenPlatformInfo) & GetPlatformInfo() const | [] |
FTargetPlatformBase::GetPlatformOrdinal | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | 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). | TargetPlatform | virtual int32 GetPlatformOrdinal() const | [] |
FTargetPlatformBase::GetPlatformSpecificProjectAnalytics | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gather per-project cook/package analytics | TargetPlatform | virtual void GetPlatformSpecificProjectAnalytics ( [TArray](API\Runtime\Core\Containers\TArray)< struct [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & AnalyticsParamArray ) const | [] |
FTargetPlatformBase::GetRayTracingShaderFormats | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets the shader formats that support ray tracing for this target platform. | TargetPlatform | virtual void GetRayTracingShaderFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFormats ) const | [] |
FTargetPlatformBase::GetShaderCompilerDependencies | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Provide platform specific file dependency patterns for SN-DBS shader compilation. | TargetPlatform | virtual void GetShaderCompilerDependencies ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutDependencies ) const | [] |
FTargetPlatformBase::GetStaticMeshOfflineBVHMode | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets static mesh offline BVH mode | TargetPlatform | virtual [EOfflineBVHMode](API\Developer\TargetPlatform\Interfaces\EOfflineBVHMode) GetStaticMeshOfflineBVHMode() const | [] |
FTargetPlatformBase::GetTargetPlatformInfo | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Returns the information about this target platform | TargetPlatform | virtual const [PlatformInfo::FTargetPlatformInfo](API\Developer\DesktopPlatform\FTargetPlatformInfo) & GetTargetPlatformInfo() const | [] |
FTargetPlatformBase::GetVariantPriority | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets the variant priority of this platform
float priority for this platform variant. | TargetPlatform | virtual float GetVariantPriority() const | [] |
FTargetPlatformBase::InitializeHostPlatform | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Initializes the host platform to support target devices (may be called multiple times after an SDK is installed while running) | TargetPlatform | virtual bool InitializeHostPlatform() | [] |
FTargetPlatformBase::IsEnabledForPlugin | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Checks whether this platform is enabled for the given plugin in the currently active project. | TargetPlatform | virtual bool IsEnabledForPlugin ( const [IPlugin](API\Runtime\Projects\Interfaces\IPlugin) & Plugin ) const | [] |
FTargetPlatformBase::IsSdkInstalled | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | 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 | TargetPlatform | virtual bool IsSdkInstalled ( bool bProjectHasCode, [FString](API\Runtime\Core\Containers\FString) & OutDocumentationPath ) const | [] |
FTargetPlatformBase::PackageBuild | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Package a build for the given platform
bool true on success, false otherwise. | TargetPlatform | virtual bool PackageBuild ( const [FString](API\Runtime\Core\Containers\FString) & InPackgeDirectory ) | [] |
FTargetPlatformBase::RequiresTempTarget | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | 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 | TargetPlatform | virtual bool RequiresTempTarget ( bool bProjectHasCode, EBuildConfiguration Configuration, bool bRequiresAssetNativization, [FText](API\Runtime\Core\Internationalization\FText) & OutReason ) const | [] |
FTargetPlatformBase::ShouldExpandTo32Bit | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Returns wheter or not this 16bit index buffer should be promoted to 32bit | TargetPlatform | virtual bool ShouldExpandTo32Bit ( const uint16 * Indices, const int32 NumIndices ) const | [] |
FTargetPlatformBase::SendLowerCaseFilePaths | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Whether or not to send all lower-case filepaths when connecting over a fileserver connection. | TargetPlatform | virtual bool SendLowerCaseFilePaths() const | [] |
FTargetPlatformBase::SupportsValueForType | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Checks whether the target platform supports the specified value for the specified type of support
true if the feature is supported, false otherwise. | TargetPlatform | virtual bool SupportsValueForType ( [FName](API\Runtime\Core\UObject\FName) SupportedType, [FName](API\Runtime\Core\UObject\FName) RequiredSupportedValue ) const | [] |
FTargetPlatformBase::SupportsVariants | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Returns true if the platform is part of a family of variants | TargetPlatform | virtual bool SupportsVariants() const | [] |
FTargetPlatformBase::UsesASTCHDR | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets whether the platform uses ASTC HDR | TargetPlatform | virtual bool UsesASTCHDR() const | [] |
FTargetPlatformBase::UsesBasePassVelocity | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets whether the platform should output velocity in the base pass. | TargetPlatform | virtual bool UsesBasePassVelocity() const | [] |
FTargetPlatformBase::UsesDBuffer | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets whether the platform should use DBuffer for decals. | TargetPlatform | virtual bool UsesDBuffer() const | [] |
FTargetPlatformBase::UsesDistanceFields | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets whether the platform will use distance fields. | TargetPlatform | virtual bool UsesDistanceFields() const | [] |
FTargetPlatformBase::UsesForwardShading | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets whether the platform should use forward shading or not. | TargetPlatform | virtual bool UsesForwardShading() const | [] |
FTargetPlatformBase::UsesMobileAmbientOcclusion | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets whether the platform uses Mobile AO | TargetPlatform | virtual bool UsesMobileAmbientOcclusion() const | [] |
FTargetPlatformBase::UsesRayTracing | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets whether the platform will use ray tracing. | TargetPlatform | virtual bool UsesRayTracing() const | [] |
FTargetPlatformBase::UsesSelectiveBasePassOutputs | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets whether the platform will use selective outputs in the base pass shaders. | TargetPlatform | virtual bool UsesSelectiveBasePassOutputs() const | [] |
FTargetPlatformBase::VelocityEncodeDepth | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets whether the platform will encode depth velocity. | TargetPlatform | virtual bool VelocityEncodeDepth() const | [] |
FTargetPlatformBase::FTargetPlatformBase | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | TargetPlatform | FTargetPlatformBase ( const [PlatformInfo::FTargetPlatformInfo](API\Developer\DesktopPlatform\FTargetPlatformInfo) *const InPlatformInfo ) | [] |
|
FTargetPlatformBase | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Base class for target platforms. | TargetPlatform | class FTargetPlatformBase : public [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) | [
{
"type": "constPlatformI...",
"name": "PlatformInfo",
"description": "Information about this platform"
},
{
"type": "int32",
"name": "PlatformOrdinal",
"description": ""
}
] |
TNonDesktopTargetPlatformBase::CookingDeviceProfileName | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets the name of the device profile to use when cooking this TargetPlatform | TargetPlatform | virtual [FString](API\Runtime\Core\Containers\FString) CookingDeviceProfileName() const | [] |
TNonDesktopTargetPlatformBase::IniPlatformName | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | PlatformName | TargetPlatform | virtual [FString](API\Runtime\Core\Containers\FString) IniPlatformName() const | [] |
TNonDesktopTargetPlatformBase::HasEditorOnlyData | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Checks whether this platform has only editor data (typically desktop platforms).
true if this platform has editor only data, false otherwise. | TargetPlatform | virtual bool HasEditorOnlyData() const | [] |
TNonDesktopTargetPlatformBase::IsClientOnly | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | 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. | TargetPlatform | virtual bool IsClientOnly() const | [] |
TNonDesktopTargetPlatformBase::IsRunningPlatform | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | 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. | TargetPlatform | virtual bool IsRunningPlatform() const | [] |
TNonDesktopTargetPlatformBase::IsServerOnly | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Checks whether this platform is only a server.
true if this platform has no graphics or audio, etc, false otherwise. | TargetPlatform | virtual bool IsServerOnly() const | [] |
TNonDesktopTargetPlatformBase::PlatformName | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | DisplayName | TargetPlatform | virtual [FString](API\Runtime\Core\Containers\FString) PlatformName() const | [] |
TNonDesktopTargetPlatformBase::TNonDesktopTargetPlatformBase | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | 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 | TargetPlatform | TNonDesktopTargetPlatformBase ( bool bInIsClientOnly, const TCHAR * CookFlavor, const TCHAR * OverrideIniPlatformName ) | [] |
TNonDesktopTargetPlatformBase | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | TargetPlatform | template<typename TPlatformProperties> class TNonDesktopTargetPlatformBase : public [TTargetPlatformBase< TPlatformProperties >](API\Developer\TargetPlatform\Common\TTargetPlatformBase) | [
{
"type": "bool",
"name": "bIsClientOnly",
"description": "True if this target platform is client-only, ie strips out server stuff"
}
] |
|
TTargetPlatformBase::CookingDeviceProfileName | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets the name of the device profile to use when cooking this TargetPlatform | TargetPlatform | virtual [FString](API\Runtime\Core\Containers\FString) CookingDeviceProfileName() const | [] |
TTargetPlatformBase::GetMemoryMappingAlignment | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets the alignment of memory mapping for this platform, typically the page size.
alignment of memory mapping. | TargetPlatform | virtual int64 GetMemoryMappingAlignment() const | [] |
TTargetPlatformBase::GetRuntimePlatformType | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | 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. | TargetPlatform | virtual EBuildTargetType GetRuntimePlatformType() const | [] |
TTargetPlatformBase::GetZlibReplacementFormat | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets a new compression format to use in place of Zlib. This should be rarely implemented
Compression format to use instead of Zlib | TargetPlatform | virtual [FName](API\Runtime\Core\UObject\FName) GetZlibReplacementFormat() const | [] |
TTargetPlatformBase::HasEditorOnlyData | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Checks whether this platform has only editor data (typically desktop platforms).
true if this platform has editor only data, false otherwise. | TargetPlatform | virtual bool HasEditorOnlyData() const | [] |
TTargetPlatformBase::HasSecurePackageFormat | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | 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. | TargetPlatform | virtual bool HasSecurePackageFormat() const | [] |
TTargetPlatformBase::IniPlatformName | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | PlatformName | TargetPlatform | virtual [FString](API\Runtime\Core\Containers\FString) IniPlatformName() const | [] |
TTargetPlatformBase::IsClientOnly | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | 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. | TargetPlatform | virtual bool IsClientOnly() const | [] |
TTargetPlatformBase::IsLittleEndian | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Checks whether this platform is little endian.
true if this platform is little-endian, false otherwise. | TargetPlatform | virtual bool IsLittleEndian() const | [] |
TTargetPlatformBase::IsServerOnly | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Checks whether this platform is only a server.
true if this platform has no graphics or audio, etc, false otherwise. | TargetPlatform | virtual bool IsServerOnly() const | [] |
TTargetPlatformBase::IsUsable | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | 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) | TargetPlatform | static bool IsUsable() | [] |
TTargetPlatformBase::PlatformName | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | DisplayName | TargetPlatform | virtual [FString](API\Runtime\Core\Containers\FString) PlatformName() const | [] |
TTargetPlatformBase::RequiresCookedData | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Checks whether this platform requires cooked data (typically console platforms).
true if this platform requires cooked data, false otherwise. | TargetPlatform | virtual bool RequiresCookedData() const | [] |
TTargetPlatformBase::RequiresOriginalReleaseVersionForPatch | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | 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. | TargetPlatform | virtual bool RequiresOriginalReleaseVersionForPatch() const | [] |
TTargetPlatformBase::RequiresUserCredentials | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Checks whether this platform requires user credentials (typically server platforms).
enum if this platform requires user credentials. | TargetPlatform | virtual [EPlatformAuthentication](API\Developer\TargetPlatform\Interfaces\EPlatformAuthentication) RequiresUserCredentials() const | [] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.