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
|
|---|---|---|---|---|---|
TTargetPlatformBase::SupportsAutoSDK | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Returns true if the platform supports the AutoSDK system | TargetPlatform | virtual bool SupportsAutoSDK() const | []
|
TTargetPlatformBase::SupportsBuildTarget | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Checks whether this platform supports the specified build target, i.e. Game or Editor.
true if the build target is supported, false otherwise. | TargetPlatform | virtual bool SupportsBuildTarget ( EBuildTargetType TargetType ) const | []
|
TTargetPlatformBase::SupportsFeature | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Checks whether the target platform supports the specified feature.
true if the feature is supported, false otherwise. | TargetPlatform | virtual bool SupportsFeature ( [ETargetPlatformFeatures](API\Developer\TargetPlatform\Interfaces\ETargetPlatformFeatures) Feature ) const | []
|
TTargetPlatformBase::UsesRayTracing | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Gets whether the platform will use ray tracing. | TargetPlatform | virtual bool UsesRayTracing() const | []
|
TTargetPlatformBase::TTargetPlatformBase | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Constructor that makes a TPI based solely on TPlatformProperties | TargetPlatform | TTargetPlatformBase() | []
|
TTargetPlatformBase::TTargetPlatformBase | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Constructor that already has a TPI (notably coming from TNonDesktopTargetPlatform) | TargetPlatform | TTargetPlatformBase ( [PlatformInfo::FTargetPlatformInfo](API\Developer\DesktopPlatform\FTargetPlatformInfo) * PremadePlatformInfo ) | []
|
TTargetPlatformBase | /Engine/Source/Developer/TargetPlatform/Public/Common/TargetPlatformBase.h | Template for target platforms. | TargetPlatform | template<typename TPlatformProperties> class TTargetPlatformBase : public [FTargetPlatformBase](API\Developer\TargetPlatform\Common\FTargetPlatformBase) | []
|
EOfflineBVHMode | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | enum EOfflineBVHMode { Disabled, MaximizePerformance, MinimizeMemory, } | []
|
|
ETargetDeviceConnectionTypes | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Enumerates how the target device is connected | TargetPlatform | enum ETargetDeviceConnectionTypes { Unknown, USB, Wifi, Ethernet, Simulator, Proprietary, } | []
|
EPlatformAuthentication | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | enum EPlatformAuthentication { Never, Possible, Always, } | []
|
|
ETargetDeviceFeatures | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Enumerates features that may be supported by target devices. | TargetPlatform | enum ETargetDeviceFeatures { MultiLaunch, PowerOff, PowerOn, ProcessSnapshot, Reboot, } | []
|
ETargetDeviceThreadStates | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Enumerates states of threads running on a target device. | TargetPlatform | enum ETargetDeviceThreadStates { Unknown, CanRun, Inactive, Inhibited, RunQueue, Running, } | []
|
ETargetDeviceTypes | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Enumerates target device types. | TargetPlatform | enum ETargetDeviceTypes { Indeterminate, Browser, Console, Desktop, Phone, Tablet, HMD, } | []
|
ETargetPlatformFeatures | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Enumerates features that may be supported by target platforms. | TargetPlatform | 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, } | []
|
FOnTargetPlatformsInvalidated | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatformManagerModule.h | TargetPlatform | typedef TMulticastDelegate_NoParams< void > FOnTargetPlatformsInvalidated | []
|
|
FSoundQualityInfo | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h | A non-UObject based structure used to pass data about a sound node wave around the engine and tools. | TargetPlatform | struct FSoundQualityInfo | [
{
"type": "bool",
"name": "bStreaming",
"description": "Holds whether the sound will be streamed."
},
{
"type": "FString",
"name": "DebugName",
"description": "Holds a string for debugging purposes."
},
{
"type": "float",
"name": "Duration",
"description": "Holds the length of the sound in seconds."
},
{
"type": "uint32",
"name": "NumChannels",
"description": "Holds the number of distinct audio channels."
},
{
"type": "int32",
"name": "Quality",
"description": "Holds the quality value ranging from 1 [poor] to 100 [very good]."
},
{
"type": "uint32",
"name": "SampleDataSize",
"description": "Holds the size of sample data in bytes."
},
{
"type": "uint32",
"name": "SampleRate",
"description": "Holds the number of PCM samples per second."
}
]
|
ETargetDeviceThreadWaitStates | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Enumerates wait states of threads running on a target device. | TargetPlatform | enum ETargetDeviceThreadWaitStates { Unknown, Locked, Sleeping, Suspended, Swapped, Waiting, } | []
|
FTargetDeviceId::GetPlatformName | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/TargetDeviceId.h | Gets the platform name.
Platform name. | TargetPlatform | const [FString](API\Runtime\Core\Containers\FString) & GetPlatformName() const | []
|
FTargetDeviceId::GetDeviceName | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/TargetDeviceId.h | Gets the device identifier.
Device identifier. | TargetPlatform | const [FString](API\Runtime\Core\Containers\FString) & GetDeviceName() const | []
|
FTargetDeviceId::IsValid | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/TargetDeviceId.h | Checks whether this target device identifier is valid.
true if the identifier is valid, false otherwise. | TargetPlatform | bool IsValid() const | []
|
FTargetDeviceId::operator== | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/TargetDeviceId.h | Compares this device identifier with the given device identifier for equality.
true if the identifiers are equal, false otherwise. | TargetPlatform | bool operator== ( const [FTargetDeviceId](API\Developer\TargetPlatform\Interfaces\FTargetDeviceId) & Other ) const | []
|
FTargetDeviceId::operator!= | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/TargetDeviceId.h | Compares this device identifier with the given device identifier for inequality.
true if the identifiers are not equal, false otherwise. | TargetPlatform | bool operator!= ( const [FTargetDeviceId](API\Developer\TargetPlatform\Interfaces\FTargetDeviceId) & Other ) const | []
|
FTargetDeviceId::Parse | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/TargetDeviceId.h | Converts a string to a target device identifier.
true if the string was converted successfully, false otherwise. | TargetPlatform | static bool Parse ( const [FString](API\Runtime\Core\Containers\FString) & IdString, [FTargetDeviceId](API\Developer\TargetPlatform\Interfaces\FTargetDeviceId) & OutId ) | []
|
FTargetDeviceId::ToString | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/TargetDeviceId.h | Gets the string representation for this device identifier.
String representation. | TargetPlatform | [FString](API\Runtime\Core\Containers\FString) ToString() const | []
|
FTargetDeviceId::FTargetDeviceId | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/TargetDeviceId.h | Default constructor. | TargetPlatform | FTargetDeviceId() | []
|
FTargetDeviceId::FTargetDeviceId | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/TargetDeviceId.h | Creates and initializes a new target device identifier. | TargetPlatform | FTargetDeviceId ( const [FString](API\Runtime\Core\Containers\FString) & InPlatformName, const [FString](API\Runtime\Core\Containers\FString) & InDeviceName ) | []
|
FTargetDeviceId | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/TargetDeviceId.h | Implements a target devices identifier. | TargetPlatform | class FTargetDeviceId | []
|
FTargetDeviceProcessInfo | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Structure for information for processes that are running on a target device. | TargetPlatform | struct FTargetDeviceProcessInfo | [
{
"type": "int64",
"name": "Id",
"description": "Holds the process identifier."
},
{
"type": "FString",
"name": "Name",
"description": "Holds the process name."
},
{
"type": "uint64",
"name": "ParentId",
"description": "Holds the identifier of the parent process."
},
{
"type": "TArray<FTarget...",
"name": "Threads",
"description": "Holds the collection of threads that belong to this process."
},
{
"type": "FString",
"name": "UserName",
"description": "The name of the user that owns this process."
}
]
|
FTargetDeviceThreadInfo | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Structure for thread information. | TargetPlatform | struct FTargetDeviceThreadInfo | [
{
"type": "uint64",
"name": "ExitCode",
"description": "Holds the exit code."
},
{
"type": "uint32",
"name": "Id",
"description": "Holds the thread identifier."
},
{
"type": "FString",
"name": "Name",
"description": "Holds the name of the thread."
},
{
"type": "uint64",
"name": "StackSize",
"description": "Holds the thread's stack size."
},
{
"type": "ETargetDeviceTh...",
"name": "State",
"description": "Holds the thread's current state."
},
{
"type": "ETargetDeviceTh...",
"name": "WaitState",
"description": "Holds the thread's current wait state."
}
]
|
FTargetPlatform::GetOrdinal | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | uint32 GetOrdinal() const | []
|
|
FTargetPlatform::operator== | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | bool operator== ( const [FTargetPlatform](API\Developer\TargetPlatform\Interfaces\FTargetPlatform) & Other ) const | []
|
|
FTargetPlatform::FTargetPlatform | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | FTargetPlatform ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) & Platform ) | []
|
|
FTargetPlatform::operator< | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | bool operator< ( const [FTargetPlatform](API\Developer\TargetPlatform\Interfaces\FTargetPlatform) & Other ) const | []
|
|
FTargetPlatformSet::Add | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | void Add ( const [FTargetPlatform](API\Developer\TargetPlatform\Interfaces\FTargetPlatform) & Platform ) | []
|
|
FTargetPlatform | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | ITargetPlatform::GetPlatformOrdinal() | TargetPlatform | struct FTargetPlatform | []
|
FTargetPlatformSet::Clear | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | void Clear() | []
|
|
FTargetPlatformSet::Contains | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Check if this set contains any of the members of the Other set. | TargetPlatform | bool Contains ( const [FTargetPlatform](API\Developer\TargetPlatform\Interfaces\FTargetPlatform) & Platform ) const | []
|
FTargetPlatformSet::ContainsAny | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Check if this set contains any of the members of the Other set. | TargetPlatform | bool ContainsAny ( const [FTargetPlatformSet](API\Developer\TargetPlatform\Interfaces\FTargetPlatformSet) & Other ) const | []
|
FTargetPlatformSet::ForEach | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Iterate over all set members | TargetPlatform | template<typename Func> void ForEach ( Func && Callback ) const | []
|
FTargetPlatformSet::GetHash | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | uint32 GetHash() const | []
|
|
FTargetPlatformSet::operator== | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | bool operator== ( const [FTargetPlatformSet](API\Developer\TargetPlatform\Interfaces\FTargetPlatformSet) & Other ) const | []
|
|
FTargetPlatformSet::IsEmpty | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | bool IsEmpty() const | []
|
|
FTargetPlatformSet::Remove | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | void Remove ( const [FTargetPlatform](API\Developer\TargetPlatform\Interfaces\FTargetPlatform) & Platform ) | []
|
|
FTargetPlatformSet::Merge | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | TargetPlatform | void Merge ( const [FTargetPlatformSet](API\Developer\TargetPlatform\Interfaces\FTargetPlatformSet) & Other ) | []
|
|
FTargetPlatformSet::Remove | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Remove all members from the Platforms set from this set. | TargetPlatform | void Remove ( const [FTargetPlatformSet](API\Developer\TargetPlatform\Interfaces\FTargetPlatformSet) & Platforms ) | []
|
FTargetPlatformSet | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetPlatform.h | Target platform set implementation using bitmask for compactness | TargetPlatform | class FTargetPlatformSet | []
|
IAudioFormat::AllowParallelBuild | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h | Note: This method is not currently used yet.
true if this audio format can cook in parallel, false otherwise. | TargetPlatform | virtual bool AllowParallelBuild() const | []
|
IAudioFormat::Cook | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h | Cooks the source data for the platform and stores the cooked data internally.
true on success, false otherwise. | TargetPlatform | 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 | []
|
IAudioFormat::CookSurround | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h | 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 | TargetPlatform | 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 | []
|
IAudioFormat::ExtractSeekTableForStreaming | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h | 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 | TargetPlatform | virtual bool ExtractSeekTableForStreaming ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InOutBuffer, [FSeekTable](API\Developer\TargetPlatform\Interfaces\IAudioFormat\FSeekTable) & OutSeektable ) const | []
|
FSeekTable | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h | TargetPlatform | struct FSeekTable | [
{
"type": "TArray< uint32 ...",
"name": "Offsets",
"description": ""
},
{
"type": "TArray< uint32 ...",
"name": "Times",
"description": ""
}
]
|
|
IAudioFormat::GetMinimumSizeForInitialChunk | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h | This is called prior toSplitDataForStreaming(), and is used for determining FirstChunkMaxSize. | TargetPlatform | virtual int32 GetMinimumSizeForInitialChunk ( [FName](API\Runtime\Core\UObject\FName) Format, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & SrcBuffer ) const | []
|
IAudioFormat::GetSupportedFormats | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h | Gets the list of supported formats. | TargetPlatform | void GetSupportedFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFormats ) const | []
|
IAudioFormat::GetVersion | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h | Gets the current version of the specified audio format.
Version number. | TargetPlatform | uint16 GetVersion ( [FName](API\Runtime\Core\UObject\FName) Format ) const | []
|
IAudioFormat::Recompress | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h | This function is, as far as I can tell, unused.
The size of the compressed audio, or 0 on failure. | TargetPlatform | 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 | []
|
IAudioFormat::RequiresStreamingSeekTable | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h | TargetPlatform | virtual bool RequiresStreamingSeekTable() const | []
|
|
IAudioFormat::SplitDataForStreaming | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h | Splits compressed data into chunks suitable for streaming audio.
Whether bulk data could be split for streaming. | TargetPlatform | 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 | []
|
IAudioFormat::~IAudioFormat | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h | Virtual destructor. | TargetPlatform | virtual ~IAudioFormat() | []
|
IAudioFormat | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormat.h | Interface for audio formats. | TargetPlatform | class IAudioFormat | []
|
IAudioFormatModule::GetAudioFormat | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormatModule.h | Gets the audio format.
The audio format interface. | TargetPlatform | [IAudioFormat](API\Developer\TargetPlatform\Interfaces\IAudioFormat) * GetAudioFormat() | []
|
IAudioFormatModule::~IAudioFormatModule | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormatModule.h | Virtual destructor. | TargetPlatform | ~IAudioFormatModule() | []
|
IAudioFormatModule | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IAudioFormatModule.h | Interface for audio format modules. | TargetPlatform | class IAudioFormatModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | []
|
IDeviceManagerCustomPlatformWidgetCreator::AddDevice | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IDeviceManagerCustomPlatformWidgetCreator.h | TargetPlatform | void AddDevice ( const [FString](API\Runtime\Core\Containers\FString) & InPlatformName, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & UserData ) | []
|
|
IDeviceManagerCustomPlatformWidgetCreator::CreateAddDeviceWidget | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IDeviceManagerCustomPlatformWidgetCreator.h | TargetPlatform | [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > CreateAddDeviceWidget ( const [FString](API\Runtime\Core\Containers\FString) & InPlatformName ) | []
|
|
IDeviceManagerCustomPlatformWidgetCreator::CreateDeviceInfoWidget | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IDeviceManagerCustomPlatformWidgetCreator.h | TargetPlatform | [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 ) | []
|
|
IDeviceManagerCustomPlatformWidgetCreator::IsAddDeviceInputValid | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IDeviceManagerCustomPlatformWidgetCreator.h | TargetPlatform | bool IsAddDeviceInputValid ( const [FString](API\Runtime\Core\Containers\FString) & InPlatformName, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & UserData ) | []
|
|
IDeviceManagerCustomPlatformWidgetCreator | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IDeviceManagerCustomPlatformWidgetCreator.h | TargetPlatform | class IDeviceManagerCustomPlatformWidgetCreator | []
|
|
IProjectBuildMutatorFeature::RequiresProjectBuild | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IProjectBuildMutatorFeature.h | TargetPlatform | bool RequiresProjectBuild ( const [FName](API\Runtime\Core\UObject\FName) & InPlatformInfoName, [FText](API\Runtime\Core\Internationalization\FText) & OutReason ) const | []
|
|
IProjectBuildMutatorFeature | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IProjectBuildMutatorFeature.h | TargetPlatform | class IProjectBuildMutatorFeature : public [IModularFeature](API\Runtime\Core\Features\IModularFeature) | []
|
|
IShaderFormat::AppendToKeyString | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | Appends shader key text to the provided key string for use in DDC unique key construction. | TargetPlatform | virtual void AppendToKeyString ( [FString](API\Runtime\Core\Containers\FString) & KeyString ) const | []
|
IShaderFormat::CanCompileBinaryShaders | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | 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. | TargetPlatform | virtual bool CanCompileBinaryShaders() const | []
|
IShaderFormat::CanStripShaderCode | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | 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. | TargetPlatform | virtual bool CanStripShaderCode ( bool const bNativeFormat ) const | []
|
IShaderFormat::CompilePreprocessedShader | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | Compile the specified preprocessed shader; only called if SupportsIndependentPreprocessing returns true | TargetPlatform | 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 | []
|
IShaderFormat::CompilePreprocessedShader | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | 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) | TargetPlatform | 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 | []
|
IShaderFormat::CompileShader | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | Compile the specified shader. Only called if SupportsIndependentPreprocessing returns false. | TargetPlatform | 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 | []
|
IShaderFormat::CreateShaderArchive | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | Create a format specific archive for precompiled shader code.
true if the archive was created | TargetPlatform | 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 | []
|
IShaderFormat::GetPackedShaderKey | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | 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. | TargetPlatform | virtual int32 GetPackedShaderKey() const | []
|
IShaderFormat::GetPlatformIncludeDirectory | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | Returns name of directory with platform specific shaders.
Name of directory with platform specific shaders. | TargetPlatform | const TCHAR * GetPlatformIncludeDirectory() const | []
|
IShaderFormat::GetSupportedFormats | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | Gets the list of supported formats. | TargetPlatform | void GetSupportedFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFormats ) const | []
|
IShaderFormat::GetVersion | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | Gets the current version of the specified shader format.
Version number. | TargetPlatform | uint32 GetVersion ( [FName](API\Runtime\Core\UObject\FName) Format ) const | []
|
IShaderFormat::ModifyShaderCompilerInput | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | 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. | TargetPlatform | virtual void ModifyShaderCompilerInput ( [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input ) const | []
|
IShaderFormat::NotifyShaderCompilersShutdown | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | Called at the end of a cook to free resources and finalize artifacts created during the cook. | TargetPlatform | virtual void NotifyShaderCompilersShutdown ( [FName](API\Runtime\Core\UObject\FName) Format ) const | []
|
IShaderFormat::NotifyShaderCompiled | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | 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. | TargetPlatform | virtual void NotifyShaderCompiled ( const TConstArrayView< uint8 > & PlatformDebugData, [FName](API\Runtime\Core\UObject\FName) Format ) const | []
|
IShaderFormat::OutputDebugData | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | 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. | TargetPlatform | 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 | []
|
IShaderFormat::OutputDebugData | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | 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. | TargetPlatform | 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 | []
|
IShaderFormat::RequiresSecondaryCompile | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | 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. | TargetPlatform | 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 | []
|
IShaderFormat::PreprocessShader | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | Executes all shader preprocessing steps; only called if SupportsIndependentPreprocessing returns true | TargetPlatform | virtual bool PreprocessShader ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, const [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & Environment, [FShaderPreprocessOutput](API\Runtime\RenderCore\FShaderPreprocessOutput) & PreprocessOutput ) const | []
|
IShaderFormat::StripShaderCode | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | 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 | TargetPlatform | virtual bool StripShaderCode ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Code, [FString](API\Runtime\Core\Containers\FString) const & DebugOutputDir, bool const bNative ) const | []
|
IShaderFormat::SupportsIndependentPreprocessing | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | Return true if preprocessing for this format can be executed independent of compilation (i.e. the format has an implementation of the PreprocessShader function). | TargetPlatform | virtual bool SupportsIndependentPreprocessing() const | []
|
IShaderFormat::SupportsShaderArchives | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | Whether this shader format supports a format-specific archive for precompiled shader code.
true if shader archives are supported, false otherwise. | TargetPlatform | virtual bool SupportsShaderArchives() const | []
|
IShaderFormat::UsesHLSLcc | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | 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. | TargetPlatform | virtual bool UsesHLSLcc ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input ) const | []
|
IShaderFormat::~IShaderFormat | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | Virtual destructor. | TargetPlatform | virtual ~IShaderFormat() | []
|
IShaderFormatModule::GetShaderFormat | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormatModule.h | Gets the shader format.
The shader format interface. | TargetPlatform | [IShaderFormat](API\Developer\TargetPlatform\Interfaces\IShaderFormat) * GetShaderFormat() | []
|
IShaderFormat | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormat.h | IShaderFormat, shader pre-compilation abstraction | TargetPlatform | class IShaderFormat | []
|
IShaderFormatModule::~IShaderFormatModule | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormatModule.h | Virtual destructor. | TargetPlatform | ~IShaderFormatModule() | []
|
IShaderFormatModule | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/IShaderFormatModule.h | Interface for shader format modules. | TargetPlatform | class IShaderFormatModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | []
|
ITargetDevice::CloseConnection | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | OpenSocket | TargetPlatform | virtual void CloseConnection ( [ITargetDeviceSocketPtr](API\Developer\TargetPlatform\Interfaces\ITargetDeviceSocketPtr) Socket ) | []
|
ITargetDevice::Connect | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Connect to the physical device.
true if the device is connected, false otherwise. | TargetPlatform | bool Connect() | []
|
ITargetDevice::CreateDeviceOutputRouter | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | This will route device logs into specified OutputDevice until connection to device is alive
Valid router object for devices that support output routing | TargetPlatform | virtual [ITargetDeviceOutputPtr](API\Developer\TargetPlatform\Interfaces\ITargetDeviceOutputPtr) CreateDeviceOutputRouter ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) * Output ) const | []
|
ITargetDevice::Disconnect | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h | Disconnect from the physical device. | TargetPlatform | void Disconnect() | []
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.