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
|
|---|---|---|---|---|---|
ITargetDevice::ExecuteConsoleCommand | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Execute console command on the device | TargetPlatform | virtual void ExecuteConsoleCommand ( const [FString](API\Runtime\Core\Containers\FString) & ExecCommand ) const | []
|
ITargetDevice::GetAllDevicesDefaultVariant | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Get the "All devices" default variant
"All devices" default variant. | TargetPlatform | virtual [FName](API\Runtime\Core\UObject\FName) GetAllDevicesDefaultVariant() const | []
|
ITargetDevice::GetAllDevicesName | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Get the "All devices" name
"All devices" name. | TargetPlatform | virtual [FString](API\Runtime\Core\Containers\FString) GetAllDevicesName() const | []
|
ITargetDevice::GetDeviceConnectionType | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Gets the device connection type.
Device connection type. | TargetPlatform | virtual [ETargetDeviceConnectionTypes](API\Developer\TargetPlatform\Interfaces\ETargetDeviceConnectionTypes) GetDeviceConnectionType() const | []
|
ITargetDevice::GetDeviceType | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Gets the device type.
Device type. | TargetPlatform | [ETargetDeviceTypes](API\Developer\TargetPlatform\Interfaces\ETargetDeviceTypes) GetDeviceType() const | []
|
ITargetDevice::GetId | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | GetName | TargetPlatform | [FTargetDeviceId](API\Developer\TargetPlatform\Interfaces\FTargetDeviceId) GetId() const | []
|
ITargetDevice::GetModelId | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Gets the device model identifier.
ModelId. | TargetPlatform | virtual [FString](API\Runtime\Core\Containers\FString) GetModelId() const | []
|
ITargetDevice::GetName | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | GetId | TargetPlatform | [FString](API\Runtime\Core\Containers\FString) GetName() const | []
|
ITargetDevice::GetOperatingSystemName | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Gets the name of the operating system running on this device.
Operating system name. | TargetPlatform | [FString](API\Runtime\Core\Containers\FString) GetOperatingSystemName() | []
|
ITargetDevice::GetOSVersion | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Gets the device OS Version.
OSVersion. | TargetPlatform | virtual [FString](API\Runtime\Core\Containers\FString) GetOSVersion() const | []
|
ITargetDevice::GetProcessSnapshot | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Creates a snapshot of processes currently running on the device.
The number of returned processes. | TargetPlatform | int32 GetProcessSnapshot ( [TArray](API\Runtime\Core\Containers\TArray)< [FTargetDeviceProcessInfo](API\Developer\TargetPlatform\Interfaces\FTargetDeviceProcessInfo) > & OutProcessInfos ) | []
|
ITargetDevice::GetProcessSnapshotAsync | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Creates a snapshot of processes currently running on the device.
True if retrieving a process snapshot is supported | TargetPlatform | virtual bool GetProcessSnapshotAsync ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [TArray](API\Runtime\Core\Containers\TArray)< [FTargetDeviceProcessInfo](API\Developer\TargetPlatform\Interfaces\FTargetDeviceProcessInfo) > &)> CompleteHandler ) | []
|
ITargetDevice::GetTargetPlatform | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Gets the TargetPlatform that this device belongs to. | TargetPlatform | const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) & GetTargetPlatform() const | []
|
ITargetDevice::GetUserCredentials | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Get credentials for the user account to use on the device
true on success, false if not supported. | TargetPlatform | bool GetUserCredentials ( [FString](API\Runtime\Core\Containers\FString) & OutUserName, [FString](API\Runtime\Core\Containers\FString) & OutUserPassword ) | []
|
ITargetDevice::IsAuthorized | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | This is true for most platforms by default, but may be false for mobile platforms
true if this this device is authorized for launch | TargetPlatform | virtual bool IsAuthorized() const | []
|
ITargetDevice::IsConnected | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Checks whether this device is connected.
true if the device is connected, false otherwise. | TargetPlatform | bool IsConnected() | []
|
ITargetDevice::IsDefault | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Note that not all platforms may have a notion of default devices.
true if this is the default device, false otherwise. | TargetPlatform | bool IsDefault() const | []
|
ITargetDevice::IsPlatformAggregated | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Get the "All devices" flag for the platform
true if the platform has an "All devices" proxy. | TargetPlatform | virtual bool IsPlatformAggregated() const | []
|
ITargetDevice::IsProtocolAvailable | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | 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. | TargetPlatform | virtual bool IsProtocolAvailable ( uint32 ProtocolIndex ) const | []
|
ITargetDevice::OpenConnection | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | ITargetDeviceSocket::Connected | TargetPlatform | virtual [ITargetDeviceSocketPtr](API\Developer\TargetPlatform\Interfaces\ITargetDeviceSocketPtr) OpenConnection ( uint32 ProtocolIndex ) | []
|
ITargetDevice::PowerOff | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Powers off the device.
true if the device will be powered off, false otherwise. | TargetPlatform | bool PowerOff ( bool Force ) | []
|
ITargetDevice::PowerOn | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Powers on the device.
true if the device will be powered on, false otherwise. | TargetPlatform | bool PowerOn() | []
|
ITargetDevice::Reboot | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Reboot the device.
true if the reboot was successful from the perspective of the PC . | TargetPlatform | bool Reboot ( bool bReconnect ) | []
|
ITargetDevice::ReloadGlobalShadersMap | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Execute console command on the device to reload the global shader map | TargetPlatform | virtual void ReloadGlobalShadersMap ( const [FString](API\Runtime\Core\Containers\FString) & GlobalShaderMapDirectory ) const | []
|
ITargetDevice::SetUserCredentials | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Set credentials for the user account to use on the device | TargetPlatform | void SetUserCredentials ( const [FString](API\Runtime\Core\Containers\FString) & UserName, const [FString](API\Runtime\Core\Containers\FString) & UserPassword ) | []
|
ITargetDevice::SupportsFeature | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Checks whether the target device supports the specified feature.
true if the feature is supported, false otherwise. | TargetPlatform | bool SupportsFeature ( [ETargetDeviceFeatures](API\Developer\TargetPlatform\Interfaces\ETargetDeviceFeatures) Feature ) const | []
|
ITargetDevice::TerminateLaunchedProcess | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Cancel the application running on the device | TargetPlatform | virtual bool TerminateLaunchedProcess ( const [FString](API\Runtime\Core\Containers\FString) & ProcessIdentifier ) | []
|
ITargetDevice::TerminateProcess | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Terminates a process that was launched on the device using the Launch() or Run() methods.
true if the process was terminated, false otherwise. | TargetPlatform | bool TerminateProcess ( const int64 ProcessId ) | []
|
ITargetDevice | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Interface for target devices. | TargetPlatform | class ITargetDevice | []
|
ITargetDevice::~ITargetDevice | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Virtual destructor. | TargetPlatform | virtual ~ITargetDevice() | []
|
ITargetDeviceOutput::~ITargetDeviceOutput | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDeviceOutput.h | Virtual destructor. | TargetPlatform | virtual ~ITargetDeviceOutput() | []
|
ITargetDeviceOutput | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDeviceOutput.h | Interface for target device output log reader. | TargetPlatform | class ITargetDeviceOutput | []
|
ITargetDeviceOutputPtr | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Type definition for shared pointers to instances ofITargetDeviceOutput. | TargetPlatform | typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ITargetDeviceOutput](API\Developer\TargetPlatform\Interfaces\ITargetDeviceOutput), ESPMode::ThreadSafe > ITargetDeviceOutputPtr | []
|
ITargetDevicePtr | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Type definition for shared pointers to instances ofITargetDevice. | TargetPlatform | typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ITargetDevice](API\Developer\TargetPlatform\Interfaces\ITargetDevice), ESPMode::ThreadSafe > ITargetDevicePtr | []
|
ITargetDeviceRef | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Type definition for shared references to instances ofITargetDevice. | TargetPlatform | typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ITargetDevice](API\Developer\TargetPlatform\Interfaces\ITargetDevice), ESPMode::ThreadSafe > ITargetDeviceRef | []
|
ITargetDeviceSocket::Connected | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDeviceSocket.h | Returns true if this socket is actually connected to another peer and is ready to send/receive data. | TargetPlatform | bool Connected() const | []
|
ITargetDeviceSocket::Receive | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDeviceSocket.h | IHostDevice::CloseConnection | TargetPlatform | bool Receive ( void * Data, uint64 BytesToReceive ) | []
|
ITargetDeviceSocket::Send | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDeviceSocket.h | IHostDevice::CloseConnection | TargetPlatform | bool Send ( const void * Data, uint64 BytesToSend ) | []
|
ITargetDeviceSocket::~ITargetDeviceSocket | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDeviceSocket.h | Virtual destructor. | TargetPlatform | virtual ~ITargetDeviceSocket() | []
|
ITargetDeviceSocket | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDeviceSocket.h | This interface provides an abstraction for communicating with processes running on the target. | TargetPlatform | class ITargetDeviceSocket | []
|
ITargetDeviceSocketPtr | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDeviceSocket.h | Type definition for shared pointers to instances ofIPlatformHostSocket. | TargetPlatform | typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDeviceSocket](API\Developer\TargetPlatform\Interfaces\ITargetDeviceSocket), ESPMode::ThreadSafe > ITargetDeviceSocketPtr | []
|
ITargetDeviceSocketRef | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDeviceSocket.h | Type definition for shared references to instances ofIPlatformHostSocket. | TargetPlatform | typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITargetDeviceSocket](API\Developer\TargetPlatform\Interfaces\ITargetDeviceSocket), ESPMode::ThreadSafe > ITargetDeviceSocketRef | []
|
ITargetDeviceWeakPtr | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Type definition for weak pointers to instances ofITargetDevice. | TargetPlatform | typedef [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< class [ITargetDevice](API\Developer\TargetPlatform\Interfaces\ITargetDevice), ESPMode::ThreadSafe > ITargetDeviceWeakPtr | []
|
ITargetPlatform::AddDevice | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Add a target device by name.
true if the device was added, false otherwise. | TargetPlatform | bool AddDevice ( const [FString](API\Runtime\Core\Containers\FString) & DeviceName, bool bDefault ) | []
|
ITargetPlatform::AddDevice | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Add a target device.
true if the device was added, false otherwise. | TargetPlatform | 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 ) | []
|
ITargetPlatform::AllowsDevelopmentObjects | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.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 | bool AllowsDevelopmentObjects() const | []
|
ITargetPlatform::AllowsEditorObjects | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.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 | bool AllowsEditorObjects() const | []
|
ITargetPlatform::AssignPlatformOrdinal | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | static int32 AssignPlatformOrdinal ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) & Platform ) | []
|
|
ITargetPlatform::CanSupportRemoteShaderCompile | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Checks whether this platform supports shader compilation over XGE interface.
true if this platform can distribute shader compilation threads with XGE. | TargetPlatform | bool CanSupportRemoteShaderCompile() const | []
|
ITargetPlatform::CheckRequirements | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.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 | 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 | []
|
ITargetPlatform::CookingDeviceProfileName | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Gets the name of the device profile to use when cooking this TargetPlatform | TargetPlatform | [FString](API\Runtime\Core\Containers\FString) CookingDeviceProfileName() const | []
|
ITargetPlatform::CopyFileToTarget | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Copy a file to the target | TargetPlatform | 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 ) | []
|
ITargetPlatform::DisplayName | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | PlatformName | TargetPlatform | [FText](API\Runtime\Core\Internationalization\FText) DisplayName() const | []
|
ITargetPlatform::EnableDeviceCheck | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Enables/Disable the device check | TargetPlatform | void EnableDeviceCheck ( bool OnOff ) | []
|
FOnTargetDeviceDiscovered | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Gets an event delegate that is executed when a new target device has been discovered. | TargetPlatform | class FOnTargetDeviceDiscovered : public TBaseMulticastDelegate_OneParam< void, ITargetDeviceRef > | []
|
FOnTargetDeviceLost | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Gets an event delegate that is executed when a target device has been lost, i.e. disconnected or timed out. | TargetPlatform | class FOnTargetDeviceLost : public TBaseMulticastDelegate_OneParam< void, ITargetDeviceRef > | []
|
ITargetPlatform::ForcesSimpleSkyDiffuse | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Gets whether the platform will use SH2 instead of SH3 for sky irradiance. | TargetPlatform | bool ForcesSimpleSkyDiffuse() const | []
|
ITargetPlatform::GenerateStreamingInstallManifest | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | 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 . | TargetPlatform | 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 | []
|
ITargetPlatform::GetAllDevices | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Returns all discoverable physical devices. | TargetPlatform | void GetAllDevices ( [TArray](API\Runtime\Core\Containers\TArray)< [ITargetDevicePtr](API\Developer\TargetPlatform\Interfaces\ITargetDevicePtr) > & OutDevices ) const | []
|
ITargetPlatform::GetAllPossibleShaderFormats | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Gets the shader formats this platform can use. | TargetPlatform | void GetAllPossibleShaderFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFormats ) const | []
|
ITargetPlatform::GetAllTargetedShaderFormats | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Gets the shader formats that have been selected for this target platform | TargetPlatform | void GetAllTargetedShaderFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFormats ) const | []
|
ITargetPlatform::GetBuildProjectSettingKeys | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Project settings to check to determine if a build should occur | TargetPlatform | 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 | []
|
ITargetPlatform::GetConfigSystem | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Returns the config system object usable by this TargetPlatform. It should not be modified in anyway | TargetPlatform | [FConfigCacheIni](API\Runtime\Core\Misc\FConfigCacheIni) * GetConfigSystem() const | []
|
ITargetPlatform::GetCustomWidgetCreator | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Returns custom DeviceManager widget creator for this platform | TargetPlatform | [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IDeviceManagerCustomPlatformWidgetCreator](API\Developer\TargetPlatform\Interfaces\IDeviceManagerCustomPlatformWidg-) > GetCustomWidgetCreator() const | []
|
ITargetPlatform::GetDefaultDevice | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Note that not all platforms may have a notion of default devices.
Default device. | TargetPlatform | [ITargetDevicePtr](API\Developer\TargetPlatform\Interfaces\ITargetDevicePtr) GetDefaultDevice() const | []
|
ITargetPlatform::GetDevice | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Gets an interface to the specified device.
The target device (can be nullptr). | TargetPlatform | [ITargetDevicePtr](API\Developer\TargetPlatform\Interfaces\ITargetDevicePtr) GetDevice ( const [FTargetDeviceId](API\Developer\TargetPlatform\Interfaces\FTargetDeviceId) & DeviceId ) | []
|
ITargetPlatform::GetDownSampleMeshDistanceFieldDivider | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Gets down sample mesh distance field divider.
1 if platform does not need to downsample mesh distance fields | TargetPlatform | float GetDownSampleMeshDistanceFieldDivider() const | []
|
ITargetPlatform::GetExtraPackagesToCook | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Gets a list of package names to cook when cooking this platform | TargetPlatform | void GetExtraPackagesToCook ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & PackageNames ) const | []
|
ITargetPlatform::GetHeightFogModeForOpaque | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.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 | int32 GetHeightFogModeForOpaque() const | []
|
ITargetPlatform::GetMemoryMappingAlignment | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Gets the alignment of memory mapping for this platform, typically the page size.
alignment of memory mapping. | TargetPlatform | int64 GetMemoryMappingAlignment() const | []
|
ITargetPlatform::GetPlatformFromOrdinal | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Given a platform ordinal number, returns the correspondingITargetPlatforminstance | TargetPlatform | static const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * GetPlatformFromOrdinal ( int32 Ordinal ) | []
|
ITargetPlatform::GetPlatformInfo | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Returns the information about the platform as a whole | TargetPlatform | const [FDataDrivenPlatformInfo](API\Runtime\Core\Misc\FDataDrivenPlatformInfo) & GetPlatformInfo() const | []
|
ITargetPlatform::GetPlatformOrdinal | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.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 | int32 GetPlatformOrdinal() const | []
|
ITargetPlatform::GetPlatformSpecificProjectAnalytics | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Gather per-project cook/package analytics | TargetPlatform | void GetPlatformSpecificProjectAnalytics ( [TArray](API\Runtime\Core\Containers\TArray)< struct [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & AnalyticsParamArray ) const | []
|
ITargetPlatform::GetRayTracingShaderFormats | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Gets the shader formats that support ray tracing for this target platform. | TargetPlatform | void GetRayTracingShaderFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFormats ) const | []
|
ITargetPlatform::GetRuntimePlatformType | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.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 | EBuildTargetType GetRuntimePlatformType() const | []
|
ITargetPlatform::GetShaderCompilerDependencies | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Provide platform specific file dependency patterns for SN-DBS shader compilation. | TargetPlatform | void GetShaderCompilerDependencies ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutDependencies ) const | []
|
ITargetPlatform::GetStaticMeshOfflineBVHMode | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Gets static mesh offline BVH mode | TargetPlatform | [EOfflineBVHMode](API\Developer\TargetPlatform\Interfaces\EOfflineBVHMode) GetStaticMeshOfflineBVHMode() const | []
|
ITargetPlatform::GetTargetPlatformInfo | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Returns the information about this target platform | TargetPlatform | const [PlatformInfo::FTargetPlatformInfo](API\Developer\DesktopPlatform\FTargetPlatformInfo) & GetTargetPlatformInfo() const | []
|
ITargetPlatform::GetVariantPriority | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Gets the variant priority of this platform
float priority for this platform variant. | TargetPlatform | float GetVariantPriority() const | []
|
ITargetPlatform::GetZlibReplacementFormat | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.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 | [FName](API\Runtime\Core\UObject\FName) GetZlibReplacementFormat() const | []
|
ITargetPlatform::HasEditorOnlyData | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Checks whether this platform has only editor data (typically desktop platforms).
true if this platform has editor only data, false otherwise. | TargetPlatform | bool HasEditorOnlyData() const | []
|
ITargetPlatform::HasSecurePackageFormat | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.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 | bool HasSecurePackageFormat() const | []
|
ITargetPlatform::IniPlatformName | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | PlatformName | TargetPlatform | [FString](API\Runtime\Core\Containers\FString) IniPlatformName() const | []
|
ITargetPlatform::InitializeHostPlatform | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Initializes the host platform to support target devices (may be called multiple times after an SDK is installed while running) | TargetPlatform | bool InitializeHostPlatform() | []
|
ITargetPlatform::IsClientOnly | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.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 | bool IsClientOnly() const | []
|
ITargetPlatform::IsEnabledForPlugin | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Checks whether this platform is enabled for the given plugin in the currently active project. | TargetPlatform | bool IsEnabledForPlugin ( const [IPlugin](API\Runtime\Projects\Interfaces\IPlugin) & Plugin ) const | []
|
ITargetPlatform::IsLittleEndian | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Checks whether this platform is little endian.
true if this platform is little-endian, false otherwise. | TargetPlatform | bool IsLittleEndian() const | []
|
ITargetPlatform::IsRunningPlatform | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.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 | bool IsRunningPlatform() const | []
|
ITargetPlatform::IsSdkInstalled | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.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 | bool IsSdkInstalled ( bool bProjectHasCode, [FString](API\Runtime\Core\Containers\FString) & OutDocumentationPath ) const | []
|
ITargetPlatform::IsServerOnly | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Checks whether this platform is only a server.
true if this platform has no graphics or audio, etc, false otherwise. | TargetPlatform | bool IsServerOnly() const | []
|
ITargetPlatform::OnDeviceDiscovered | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | static [FOnTargetDeviceDiscovered](API\Developer\TargetPlatform\Interfaces\ITargetPlatform\FOnTargetDeviceDiscovered) & OnDeviceDiscovered() | []
|
|
ITargetPlatform::OnDeviceLost | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | static [FOnTargetDeviceLost](API\Developer\TargetPlatform\Interfaces\ITargetPlatform\FOnTargetDeviceLost) & OnDeviceLost() | []
|
|
ITargetPlatform::PackageBuild | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Package a build for the given platform
bool true on success, false otherwise. | TargetPlatform | bool PackageBuild ( const [FString](API\Runtime\Core\Containers\FString) & InPackgeDirectory ) | []
|
ITargetPlatform::PlatformName | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | DisplayName | TargetPlatform | [FString](API\Runtime\Core\Containers\FString) PlatformName() const | []
|
ITargetPlatform::RequiresCookedData | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Checks whether this platform requires cooked data (typically console platforms).
true if this platform requires cooked data, false otherwise. | TargetPlatform | bool RequiresCookedData() const | []
|
ITargetPlatform::RequiresOriginalReleaseVersionForPatch | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.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 | bool RequiresOriginalReleaseVersionForPatch() const | []
|
ITargetPlatform::RequiresTempTarget | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.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 | bool RequiresTempTarget ( bool bProjectHasCode, EBuildConfiguration Configuration, bool bRequiresAssetNativization, [FText](API\Runtime\Core\Internationalization\FText) & OutReason ) const | []
|
ITargetPlatform::RequiresUserCredentials | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Checks whether this platform requires user credentials (typically server platforms).
enum if this platform requires user credentials. | TargetPlatform | [EPlatformAuthentication](API\Developer\TargetPlatform\Interfaces\EPlatformAuthentication) RequiresUserCredentials() const | []
|
ITargetPlatform::SendLowerCaseFilePaths | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Whether or not to send all lower-case filepaths when connecting over a fileserver connection. | TargetPlatform | bool SendLowerCaseFilePaths() const | []
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.