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
|
|---|---|---|---|---|---|
FFileCacheConfig | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | Configuration structure required to construct aFFileCache | DirectoryWatcher | struct FFileCacheConfig | [
{
"type": "bool",
"name": "bDetectChangesSinceLastRun",
"description": "When true, changes to the directory since the cache shutdown will be detected and reported."
},
{
"type": "FString",
"name": "CacheFile",
"description": "String specifying the file that the cache should be saved to."
},
{
"type": "TFunction<TOpt...",
"name": "CustomChangeLogic",
"description": "User-specified custom change detection logic."
},
{
"type": "FString",
"name": "Directory",
"description": "String specifying the directory on disk that the cache should reflect"
},
{
"type": "EPathType",
"name": "PathType",
"description": "Path type to return, relative to the directory or absolute."
},
{
"type": "FMatchRules",
"name": "Rules",
"description": "List of rules which define what we will be watching"
}
] |
Key | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | DirectoryWatcher | static const [FGuid](API\Runtime\Core\Misc\FGuid) Key; | [] |
|
Type | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | DirectoryWatcher | enum Type { Initial, IncludeFileHash, Latest = IncludeFileHash, } | [] |
|
FFileCacheCustomVersion | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | Custom serialization version forFFileCache | DirectoryWatcher | struct FFileCacheCustomVersion | [] |
EFileChangeAction | /Engine/Source/Developer/DirectoryWatcher/Public/IDirectoryWatcher.h | DirectoryWatcher | enum EFileChangeAction { FCA_Unknown, FCA_Added, FCA_Modified, FCA_Removed, FCA_RescanRequired, } | [] |
|
FFileChangeData::FFileChangeData | /Engine/Source/Developer/DirectoryWatcher/Public/IDirectoryWatcher.h | DirectoryWatcher | FFileChangeData ( const [FString](API\Runtime\Core\Containers\FString) & InFilename, [EFileChangeAction](API\Developer\DirectoryWatcher\FFileChangeData\EFileChangeAction) InAction ) | [] |
|
FFileChangeData | /Engine/Source/Developer/DirectoryWatcher/Public/IDirectoryWatcher.h | DirectoryWatcher | struct FFileChangeData | [
{
"type": "EFileChangeActi...",
"name": "Action",
"description": "The reported Action."
},
{
"type": "FString",
"name": "Filename",
"description": "If the Action references a specific file, the name of the file."
},
{
"type": "int64",
"name": "TimeStamp",
"description": "If the Action references a timestamp, the timezone UTC UnixTimeStamp (e.g. FDateTime::ToUnixTimeStamp) of the Action."
}
] |
|
FFileData::FFileData | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | DirectoryWatcher | FFileData ( const [FDateTime](API\Runtime\Core\Misc\FDateTime) & InTimestamp, const [FMD5Hash](API\Runtime\Core\Misc\FMD5Hash) & InFileHash ) | [] |
|
FFileData::FFileData | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | Constructiors | DirectoryWatcher | FFileData() | [] |
FFileData | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | Structure representing specific information about a particular file | DirectoryWatcher | struct FFileData | [
{
"type": "FMD5Hash",
"name": "FileHash",
"description": "The cached MD5 hash of the file on disk"
},
{
"type": "FDateTime",
"name": "Timestamp",
"description": "The cached timestamp of the file on disk"
}
] |
FFilenameAndHash::FFilenameAndHash | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | DirectoryWatcher | FFilenameAndHash() | [] |
|
FFilenameAndHash::FFilenameAndHash | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | DirectoryWatcher | FFilenameAndHash ( const [FString](API\Runtime\Core\Containers\FString) & File ) | [] |
|
FFilenameAndHash | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | Simple struct that encapsulates a filename and its associated MD5 hash | DirectoryWatcher | struct FFilenameAndHash | [
{
"type": "FString",
"name": "AbsoluteFilename",
"description": ""
},
{
"type": "FMD5Hash",
"name": "FileHash",
"description": ""
}
] |
FImmutableString::Get | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | Get the underlying string | DirectoryWatcher | const [FString](API\Runtime\Core\Containers\FString) & Get() const | [] |
FImmutableString::operator= | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | DirectoryWatcher | [FImmutableString](API\Developer\DirectoryWatcher\FImmutableString) & operator= ( [FString](API\Runtime\Core\Containers\FString) InString ) | [] |
|
FImmutableString::operator= | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | DirectoryWatcher | [FImmutableString](API\Developer\DirectoryWatcher\FImmutableString) & operator= ( const TCHAR * InString ) | [] |
|
FImmutableString::operator= | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | DirectoryWatcher | [FImmutableString](API\Developer\DirectoryWatcher\FImmutableString) & operator= ( const [FImmutableString](API\Developer\DirectoryWatcher\FImmutableString) & ) | [] |
|
FImmutableString::operator= | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | DirectoryWatcher | [FImmutableString](API\Developer\DirectoryWatcher\FImmutableString) & operator= ( [FImmutableString](API\Developer\DirectoryWatcher\FImmutableString) && In ) | [] |
|
FImmutableString::FImmutableString | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | Constructible from a raw string | DirectoryWatcher | FImmutableString ( [FString](API\Runtime\Core\Containers\FString) InString ) | [] |
FImmutableString::FImmutableString | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | DirectoryWatcher | FImmutableString ( const TCHAR * InString ) | [] |
|
FImmutableString::FImmutableString | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | DirectoryWatcher | FImmutableString ( const [FImmutableString](API\Developer\DirectoryWatcher\FImmutableString) & ) | [] |
|
FImmutableString::FImmutableString | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | Move construction/assignment | DirectoryWatcher | FImmutableString ( [FImmutableString](API\Developer\DirectoryWatcher\FImmutableString) && In ) | [] |
FImmutableString | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | An immutable string with a cached CRC for efficient comparison with other strings | DirectoryWatcher | struct FImmutableString | [] |
FMatchRules::AddWildcardRule | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | Specify a wildcard match to include or exclude | DirectoryWatcher | void AddWildcardRule ( const [FWildcardString](API\Runtime\Core\Misc\FWildcardString) & WildcardString, bool bInclude ) | [] |
EType | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | DirectoryWatcher | enum EType { Wildcard, } | [] |
|
FMatchRule | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | Implementation of a match rule, wrapping up its type, and implementation | DirectoryWatcher | struct FMatchRule | [
{
"type": "TSharedPtr<IMa...",
"name": "RuleImpl",
"description": "The runtime implementation"
},
{
"type": "TEnumAsByte< ET...",
"name": "Type",
"description": "The type of this rule"
}
] |
FMatchRules::IsFileApplicable | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | Check whether the specified file is applicable based on these rules or not | DirectoryWatcher | bool IsFileApplicable ( const TCHAR * Filename ) const | [] |
FMatchRules::SetApplicableExtensions | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | Specify a set of applicable extensions, ; separated. Provided as an optimization to early-out on files we're not interested in. | DirectoryWatcher | void SetApplicableExtensions ( const [FString](API\Runtime\Core\Containers\FString) & InExtensions ) | [] |
FMatchRules::FMatchRules | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | DirectoryWatcher | FMatchRules() | [] |
|
FMatchRules | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | A set of rules that specifies what files we'll be watching | DirectoryWatcher | struct FMatchRules | [] |
FTimeLimit::Exceeded | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | Check whether we have exceeded the time limit | DirectoryWatcher | bool Exceeded() const | [] |
FTimeLimit::IsValid | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | Return true if this time limit has been set up, false otherwise | DirectoryWatcher | bool IsValid() const | [] |
FTimeLimit::Reset | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | Reset the time limit to start timing again from the current time | DirectoryWatcher | void Reset() | [] |
FTimeLimit::FTimeLimit | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | Constructor specifying not to run over the specified number of seconds | DirectoryWatcher | FTimeLimit ( float NumSeconds ) | [] |
FTimeLimit::FTimeLimit | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | Constructor specifying that we should never bail out early | DirectoryWatcher | FTimeLimit() | [] |
FTimeLimit | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | A time limit that counts down from the time of construction, until it hits a given delay | DirectoryWatcher | struct FTimeLimit | [] |
FUpdateCacheTransaction::operator= | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | DirectoryWatcher | [FUpdateCacheTransaction](API\Developer\DirectoryWatcher\FUpdateCacheTransaction) & operator= ( [FUpdateCacheTransaction](API\Developer\DirectoryWatcher\FUpdateCacheTransaction) && In ) | [] |
|
FUpdateCacheTransaction::operator= | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | DirectoryWatcher | FUpdateCacheTransaction & operator&61; &40; const FUpdateCacheTransaction & &41; | [] |
|
FUpdateCacheTransaction::FUpdateCacheTransaction | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | Publically moveable | DirectoryWatcher | FUpdateCacheTransaction ( [FUpdateCacheTransaction](API\Developer\DirectoryWatcher\FUpdateCacheTransaction) && In ) | [] |
FUpdateCacheTransaction::FUpdateCacheTransaction | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | Not Copyable | DirectoryWatcher | FUpdateCacheTransaction &40; const FUpdateCacheTransaction & &41; | [] |
FUpdateCacheTransaction::FUpdateCacheTransaction | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | Construction responsibility is held byFFileCache | DirectoryWatcher | FUpdateCacheTransaction &40; FImmutableString InFilename, EFileAction InAction, const FFileData & InFileData &41; | [] |
FUpdateCacheTransaction::FUpdateCacheTransaction | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | Construction responsibility is held byFFileCache | DirectoryWatcher | FUpdateCacheTransaction &40; FImmutableString InMovedFromFilename, FImmutableString InMovedToFilename, const FFileData & InFileData &41; | [] |
FUpdateCacheTransaction | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | A transaction issued byFFileCacheto describe a change to the cache. The change is only committed once the transaction is returned to the cache (seeFFileCache::CompleteTransaction). | DirectoryWatcher | struct FUpdateCacheTransaction | [
{
"type": "EFileAction",
"name": "Action",
"description": "The type of action that prompted this transaction"
},
{
"type": "FFileData",
"name": "FileData",
"description": "File data pertaining to this change at the time of dispatch"
},
{
"type": "FImmutableStrin...",
"name": "Filename",
"description": "The path of the file to which this transaction relates"
},
{
"type": "FImmutableStrin...",
"name": "MovedFromFilename",
"description": "In the case of a moved file, this represents the path the file was moved from"
}
] |
EProgressResult | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | DirectoryWatcher | enum EProgressResult { Finished, Pending, } | [] |
|
IAsyncFileCacheTask::GetAge | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | Get the age of this task in seconds | DirectoryWatcher | double GetAge() const | [] |
IAsyncFileCacheTask::IsComplete | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | Check whether this task is complete. Must be implemented in a thread-safe manner. | DirectoryWatcher | bool IsComplete() const | [] |
IAsyncFileCacheTask::Tick | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | Tick this task. Only to be called on the task thread. | DirectoryWatcher | [EProgressResult](API\Developer\DirectoryWatcher\IAsyncFileCacheTask\EProgressResult) Tick ( const [FTimeLimit](API\Developer\DirectoryWatcher\FTimeLimit) & TimeLimit ) | [] |
IAsyncFileCacheTask::IAsyncFileCacheTask | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | DirectoryWatcher | IAsyncFileCacheTask() | [] |
|
IAsyncFileCacheTask | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | DirectoryWatcher | struct IAsyncFileCacheTask : public [TSharedFromThis< IAsyncFileCacheTask, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis) | [
{
"type": "double",
"name": "StartTime",
"description": "The time this task started"
}
] |
|
IAsyncFileCacheTask::~IAsyncFileCacheTask | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h | DirectoryWatcher | virtual ~IAsyncFileCacheTask() | [] |
|
IDirectoryWatcher::DumpStats | /Engine/Source/Developer/DirectoryWatcher/Public/IDirectoryWatcher.h | Allows for subclasses to dump notify statistics (returns true if implemented) | DirectoryWatcher | virtual bool DumpStats() | [] |
FDirectoryChanged | /Engine/Source/Developer/DirectoryWatcher/Public/IDirectoryWatcher.h | A delegate to report directory changes | DirectoryWatcher | typedef TBaseDelegate_OneParam< void, const [TArray](API\Runtime\Core\Containers\TArray)< struct [FFileChangeData](API\Developer\DirectoryWatcher\FFileChangeData) > & > FDirectoryChanged | [] |
IDirectoryWatcher::RegisterDirectoryChangedCallback_Handle | /Engine/Source/Developer/DirectoryWatcher/Public/IDirectoryWatcher.h | Register a callback to fire when directories are changed | DirectoryWatcher | bool RegisterDirectoryChangedCallback_Handle ( const [FString](API\Runtime\Core\Containers\FString) & Directory, const [FDirectoryChanged](API\Developer\DirectoryWatcher\IDirectoryWatcher\FDirectoryChanged) & InDelegate, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & OutHandle, uint32 Flags ) | [] |
IDirectoryWatcher::Tick | /Engine/Source/Developer/DirectoryWatcher/Public/IDirectoryWatcher.h | Allows for subclasses to be ticked (by editor or other programs that need to tick the singleton) | DirectoryWatcher | virtual void Tick ( float DeltaSeconds ) | [] |
IDirectoryWatcher::UnregisterDirectoryChangedCallback_Handle | /Engine/Source/Developer/DirectoryWatcher/Public/IDirectoryWatcher.h | Unregisters a callback to fire when directories are changed | DirectoryWatcher | bool UnregisterDirectoryChangedCallback_Handle ( const [FString](API\Runtime\Core\Containers\FString) & Directory, [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) InHandle ) | [] |
WatchOptions | /Engine/Source/Developer/DirectoryWatcher/Public/IDirectoryWatcher.h | Options for a single watch (can be combined) | DirectoryWatcher | enum WatchOptions { IncludeDirectoryChanges = (1<<0), IgnoreChangesInSubtree = (1<<1), } | [] |
IDirectoryWatcher::~IDirectoryWatcher | /Engine/Source/Developer/DirectoryWatcher/Public/IDirectoryWatcher.h | Virtual destructor | DirectoryWatcher | virtual ~IDirectoryWatcher() | [] |
IDirectoryWatcher | /Engine/Source/Developer/DirectoryWatcher/Public/IDirectoryWatcher.h | The public interface for the directory watcher singleton. | DirectoryWatcher | class IDirectoryWatcher | [] |
IMatchRule::IsFileApplicable | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | Test to see if a file is applicable based on this rule. Returns true if so, false of not, or empty if the file doesn't match this rule. | DirectoryWatcher | [TOptional](API\Runtime\Core\IO\TOptional)< bool > IsFileApplicable ( const TCHAR * Filename ) const | [] |
IMatchRule::Serialize | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | Serialize this rule | DirectoryWatcher | void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) | [] |
IMatchRule | /Engine/Source/Developer/DirectoryWatcher/Public/FileCacheUtilities.h | A rule that checks whether a file is applicable or not | DirectoryWatcher | struct IMatchRule | [] |
FDistributedBuildTaskResult | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | DistributedBuildInterface | struct FDistributedBuildTaskResult | [
{
"type": "bool",
"name": "bCompleted",
"description": ""
},
{
"type": "int32",
"name": "ReturnCode",
"description": ""
}
] |
|
FTask | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | DistributedBuildInterface | struct FTask | [
{
"type": "FTaskCommandDat...",
"name": "CommandData",
"description": ""
},
{
"type": "uint32",
"name": "ID",
"description": ""
},
{
"type": "TPromise<FDist...",
"name": "Promise",
"description": ""
}
] |
|
FTask::FTask | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | DistributedBuildInterface | FTask ( uint32 ID, const [FTaskCommandData](API\Developer\DistributedBuildInterface\FTaskCommandData) & CommandData, [TPromise](API\Runtime\Core\Async\TPromise)< [FDistributedBuildTaskResult](API\Developer\DistributedBuildInterface\FDistributedBuildTaskResult) > && Promise ) | [] |
|
FTaskCommandData | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | DistributedBuildInterface | struct FTaskCommandData | [
{
"type": "FString",
"name": "Command",
"description": ""
},
{
"type": "TArray<FString...",
"name": "Dependencies",
"description": ""
},
{
"type": "uint32",
"name": "DispatcherPID",
"description": ""
},
{
"type": "FString",
"name": "ExtraCommandArgs",
"description": ""
},
{
"type": "FString",
"name": "InputFileName",
"description": ""
},
{
"type": "FString",
"name": "OutputFileName",
"description": ""
},
{
"type": "FString",
"name": "WorkingDirectory",
"description": ""
}
] |
|
IDistributedBuildController::CreateUniqueFilePath | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | Returns a new file path to be used for writing input data to. | DistributedBuildInterface | [FString](API\Runtime\Core\Containers\FString) CreateUniqueFilePath() | [] |
IDistributedBuildController::EnqueueTask | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | Launches a task. Returns a future which can be waited on for the results. | DistributedBuildInterface | [TFuture](API\Runtime\Core\Async\TFuture)< [FDistributedBuildTaskResult](API\Developer\DistributedBuildInterface\FDistributedBuildTaskResult) > EnqueueTask ( const [FTaskCommandData](API\Developer\DistributedBuildInterface\FTaskCommandData) & CommandData ) | [] |
IDistributedBuildController::GetModularFeatureType | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | DistributedBuildInterface | static const [FName](API\Runtime\Core\UObject\FName) & GetModularFeatureType() | [] |
|
IDistributedBuildController::GetName | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | Returns the name of the controller. Used for logging purposes. | DistributedBuildInterface | const [FString](API\Runtime\Core\Containers\FString) GetName() | [] |
IDistributedBuildController::InitializeController | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | DistributedBuildInterface | void InitializeController() | [] |
|
IDistributedBuildController::IsSupported | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | Returns true if the controller may be used. | DistributedBuildInterface | bool IsSupported() | [] |
IDistributedBuildController::RemapPath | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | DistributedBuildInterface | virtual [FString](API\Runtime\Core\Containers\FString) RemapPath ( const [FString](API\Runtime\Core\Containers\FString) & SourcePath ) const | [] |
|
IDistributedBuildController::RequiresRelativePaths | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | DistributedBuildInterface | virtual bool RequiresRelativePaths() | [] |
|
FTaskResponse | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | DistributedBuildInterface | struct FTaskResponse | [
{
"type": "uint32",
"name": "ID",
"description": ""
},
{
"type": "int32",
"name": "ReturnCode",
"description": ""
}
] |
|
IDistributedBuildController::SupportsDynamicReloading | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | Override this to set whether your module is allowed to be unloaded on the fly
Whether the module supports shutdown separate from the rest of the engine. | DistributedBuildInterface | virtual bool SupportsDynamicReloading() | [] |
IDistributedBuildController::Tick | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | DistributedBuildInterface | virtual void Tick ( float DeltaSeconds ) | [] |
|
IDistributedBuildController | /Engine/Source/Developer/DistributedBuildInterface/Public/DistributedBuildControllerInterface.h | DistributedBuildInterface | class IDistributedBuildController : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface), public [IModularFeature](API\Runtime\Core\Features\IModularFeature) | [] |
|
IDrawPrimitiveDebugger::CaptureSingleFrame | /Engine/Source/Developer/DrawPrimitiveDebugger/Public/DrawPrimitiveDebugger.h | Instructs the renderer to capture a snapshot for the debugger on the next frame. | DrawPrimitiveDebugger | void CaptureSingleFrame() | [] |
IDrawPrimitiveDebugger::CloseDebugWindow | /Engine/Source/Developer/DrawPrimitiveDebugger/Public/DrawPrimitiveDebugger.h | Closes the graphics debugger window if it is currently open. | DrawPrimitiveDebugger | void CloseDebugWindow() | [] |
IDrawPrimitiveDebugger::DisableLiveCapture | /Engine/Source/Developer/DrawPrimitiveDebugger/Public/DrawPrimitiveDebugger.h | Disables capturing debug data each frame. | DrawPrimitiveDebugger | void DisableLiveCapture() | [] |
IDrawPrimitiveDebugger::EnableLiveCapture | /Engine/Source/Developer/DrawPrimitiveDebugger/Public/DrawPrimitiveDebugger.h | Enables capturing debug data each frame. | DrawPrimitiveDebugger | void EnableLiveCapture() | [] |
IDrawPrimitiveDebugger::Get | /Engine/Source/Developer/DrawPrimitiveDebugger/Public/DrawPrimitiveDebugger.h | Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed | DrawPrimitiveDebugger | static [IDrawPrimitiveDebugger](API\Developer\DrawPrimitiveDebugger\IDrawPrimitiveDebugger) & Get() | [] |
IDrawPrimitiveDebugger::IsAvailable | /Engine/Source/Developer/DrawPrimitiveDebugger/Public/DrawPrimitiveDebugger.h | Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use | DrawPrimitiveDebugger | static bool IsAvailable() | [] |
IDrawPrimitiveDebugger::IsLiveCaptureEnabled | /Engine/Source/Developer/DrawPrimitiveDebugger/Public/DrawPrimitiveDebugger.h | Is live data capture enabled for the debugger? This implies that the renderer will capture debug data each frame.
True if live capture is enabled. | DrawPrimitiveDebugger | bool IsLiveCaptureEnabled() const | [] |
IDrawPrimitiveDebugger::OpenDebugWindow | /Engine/Source/Developer/DrawPrimitiveDebugger/Public/DrawPrimitiveDebugger.h | Opens the graphics debugger window if it is available. | DrawPrimitiveDebugger | void OpenDebugWindow() | [] |
IDrawPrimitiveDebugger | /Engine/Source/Developer/DrawPrimitiveDebugger/Public/DrawPrimitiveDebugger.h | This tool allows easy on screen debugging of graphics data, primarily on-screen primitives | DrawPrimitiveDebugger | class IDrawPrimitiveDebugger : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | [] |
UDrawPrimitiveDebuggerUserSettings::GetCategoryName | /Engine/Source/Developer/DrawPrimitiveDebugger/Public/DrawPrimitiveDebuggerConfig.h | Gets the category for the settings, some high level grouping like, Editor, Engine, Game...etc. | DrawPrimitiveDebugger | virtual [FName](API\Runtime\Core\UObject\FName) GetCategoryName() const | [] |
UDrawPrimitiveDebuggerUserSettings::GetFontSize | /Engine/Source/Developer/DrawPrimitiveDebugger/Public/DrawPrimitiveDebuggerConfig.h | DrawPrimitiveDebugger | static int32 GetFontSize() | [] |
|
UDrawPrimitiveDebuggerUserSettings::SetFontSize | /Engine/Source/Developer/DrawPrimitiveDebugger/Public/DrawPrimitiveDebuggerConfig.h | DrawPrimitiveDebugger | static void SetFontSize ( const int32 InFontSize ) | [] |
|
UDrawPrimitiveDebuggerUserSettings | /Engine/Source/Developer/DrawPrimitiveDebugger/Public/DrawPrimitiveDebuggerConfig.h | DrawPrimitiveDebugger | class UDrawPrimitiveDebuggerUserSettings : public [UDeveloperSettings](API\Runtime\DeveloperSettings\Engine\UDeveloperSettings) | [
{
"type": "int32",
"name": "FontSize",
"description": "Font Size used by Draw Primitive Debugger"
}
] |
|
CleanupDeprecatedAnalyticSessions | /Engine/Source/Developer/EditorAnalyticsSession/Public/EditorAnalyticsSession.h | This function removes expired sessions that were created by the deprecated system. | EditorAnalyticsSession | void CleanupDeprecatedAnalyticSessions ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & MaxAge ) | [] |
deprecated | /Engine/Source/Developer/EditorAnalyticsSession/Public/EditorSessionSummarySender.h | EditorAnalyticsSession | class deprecated ( "Deprecated. This class was replaced by [FAnalyticsSessionSummarySender](API\Runtime\AnalyticsET\FAnalyticsSessionSummarySender)"" Please update your code to the new API before upgrading to the next release, otherwise your project will no longer compile." ) | [] |
|
FEditorAnalyticsSession | /Engine/Source/Developer/EditorAnalyticsSession/Public/EditorAnalyticsSession.h | Deprecated* Deprecated. This class was replaced by FEngineAnalyticsSessionSummary/FEditorAnalyticsSessionSummary | EditorAnalyticsSession | struct FEditorAnalyticsSession | [] |
FEditorAnalyticsSessionModule | /Engine/Source/Developer/EditorAnalyticsSession/Public/EditorAnalyticsSession.h | EditorAnalyticsSession | class FEditorAnalyticsSessionModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | [] |
|
FEditorSessionSummarySender | /Engine/Source/Developer/EditorAnalyticsSession/Public/EditorSessionSummarySender.h | EditorAnalyticsSession | class FEditorSessionSummarySender | [] |
|
FExternalImagePickerConfiguration::FExternalImagePickerConfiguration | /Engine/Source/Developer/ExternalImagePicker/Public/IExternalImagePickerModule.h | ExternalImagePicker | FExternalImagePickerConfiguration() | [] |
|
FExternalImagePickerConfiguration | /Engine/Source/Developer/ExternalImagePicker/Public/IExternalImagePickerModule.h | Used for configuring the external image picker | ExternalImagePicker | struct FExternalImagePickerConfiguration | [
{
"type": "bool",
"name": "bRequiresSpecificSize",
"description": "Does the image need to be a specific size?"
},
{
"type": "FString",
"name": "DefaultImagePath",
"description": "The image on disk that we will use if the target does not exist."
},
{
"type": "TArray<FString...",
"name": "FileExtensions",
"description": "The image on disk that we will use if the target does not exist."
},
{
"type": "FText",
"name": "GenerateImageToolTipText",
"description": "Tooltip for Generate Image button"
},
{
"type": "TAttribute<EVi...",
"name": "GenerateImageVisibility",
"description": "Whether the button to generate a new image should be shown."
},
{
"type": "FVector2D",
"name": "MaxDisplayedImageDimensions",
"description": "The dimensions the image display should be constrained to. Aspect ratio is maintained."
},
{
"type": "FOnExternalImag...",
"name": "OnExternalImagePicked",
"description": "Delegate fired when picking a new image."
},
{
"type": "FOnClicked",
"name": "OnGenerateImageClicked",
"description": "Delegate fired when an Generate Image button is pressed"
},
{
"type": "FOnGetPickerPat...",
"name": "OnGetPickerPath",
"description": "The path the picker will use to start from"
},
{
"type": "TSharedPtr< cla...",
"name": "PropertyHandle",
"description": "A property handle to use if required"
},
{
"type": "FIntPoint",
"name": "RequiredImageDimensions",
"description": "The size the actual image needs to be (ignored unless bRequiresSpecificSize is set)"
},
{
"type": "FString",
"name": "TargetImagePath",
"description": "The image on disk that the external image is stored as."
}
] |
FOnExternalImagePicked | /Engine/Source/Developer/ExternalImagePicker/Public/IExternalImagePickerModule.h | Delegate fired when picking a new image. | ExternalImagePicker | typedef TBaseDelegate_TwoParams< bool, const [FString](API\Runtime\Core\Containers\FString) &, const [FString](API\Runtime\Core\Containers\FString) & > FOnExternalImagePicked | [] |
FOnGetPickerPath | /Engine/Source/Developer/ExternalImagePicker/Public/IExternalImagePickerModule.h | Delegate fired to get the path to start picking from. | ExternalImagePicker | typedef TBaseDelegate_NoParams< [FString](API\Runtime\Core\Containers\FString) > FOnGetPickerPath | [] |
IExternalImagePickerModule::Get | /Engine/Source/Developer/ExternalImagePicker/Public/IExternalImagePickerModule.h | Gets a reference to the ExternalImagePicker module instance.
A reference to the ExternalImagePicker module. | ExternalImagePicker | static [IExternalImagePickerModule](API\Developer\ExternalImagePicker\IExternalImagePickerModule) & Get() | [] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.