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
FTableImportService
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TableImport.h
TraceServices
class FTableImportService
[]
FTableMergeService::MergeTables
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TableMerge.h
TraceServices
static void MergeTables ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IUntypedTable](API\Developer\TraceServices\TraceServices\Containers\IUntypedTable) > & TableA, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IUntypedTable](API\Developer\TraceServices\TraceServices\Containers\IUntypedTable) > & TableB, [TableDiffCallback](API\Developer\TraceServices\TraceServices\Model\FTableMergeService\TableDiffCallbac-) InCallback )
[]
TableDiffCallback
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TableMerge.h
TraceServices
typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FTableDiffCallbackParams](API\Developer\TraceServices\TraceServices\Model\FTableDiffCallbackParams) >)> TableDiffCallback
[]
FTableMergeService
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TableMerge.h
TraceServices
class FTableMergeService
[]
FTaskInfo::FRelationInfo::FRelationInfo
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TasksProfiler.h
TraceServices
FRelationInfo &40; TaskTrace::FId InRelativeId, double InTimestamp, uint32 InThreadId &41;
[]
FRelationInfo
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TasksProfiler.h
Relation with another task, when and where it was established
TraceServices
struct FRelationInfo
[ { "type": "TaskTrace::FId", "name": "RelativeId", "description": "" }, { "type": "uint32", "name": "ThreadId", "description": "" }, { "type": "double", "name": "Timestamp", "description": "" } ]
FTaskInfo::FTaskInfo
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TasksProfiler.h
TraceServices
FTaskInfo()
[]
FTaskInfo
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TasksProfiler.h
Task biography
TraceServices
struct FTaskInfo
[ { "type": "bool", "name": "bTracked", "description": "" }, { "type": "uint32", "name": "CompletedThreadId", "description": "" }, { "type": "double", "name": "CompletedTimestamp", "description": "Execution done and all nested tasks are completed" }, { "type": "uint32", "name": "CreatedThreadId", "description": "" }, { "type": "double", "name": "CreatedTimestamp", "description": "Some tasks can be created with delayed launch, otherwise \"created\" and \"launched\" timestamps and thread IDs are equal" }, { "type": "const TCHAR \u0004...", "name": "DebugName", "description": "This members are filled during task launch" }, { "type": "uint32", "name": "DestroyedThreadId", "description": "" }, { "type": "double", "name": "DestroyedTimestamp", "description": "The last reference is released and the task is destroyed" }, { "type": "double", "name": "FinishedTimestamp", "description": "Execution finished, but the task can be still not completed waiting for all nested tasks to complete" }, { "type": "TaskTrace::FId", "name": "Id", "description": "" }, { "type": "uint32", "name": "LaunchedThreadId", "description": "" }, { "type": "double", "name": "LaunchedTimestamp", "description": "The moment and the place when the task was launched" }, { "type": "TArray<FRelati...", "name": "NestedTasks", "description": "The task is completed only after all nested tasks are completed" }, { "type": "TArray<FRelati...", "name": "ParentTasks", "description": "Other tasks that have this task as a nested" }, { "type": "TArray<FRelati...", "name": "Prerequisites", "description": "Other tasks that must complete before this task can be scheduled" }, { "type": "uint32", "name": "ScheduledThreadId", "description": "" }, { "type": "double", "name": "ScheduledTimestamp", "description": "The moment and the place when all task's dependencies are resolved and it's added to the execution queue" }, { "type": "uint32", "name": "StartedThreadId", "description": "" }, { "type": "double", "name": "StartedTimestamp", "description": "Execution started" }, { "type": "TArray<FRelati...", "name": "Subsequents", "description": "Other tasks that wait for this task completion before they'll start execution" }, { "type": "uint64", "name": "TaskSize", "description": "Task size including user-provided task body" }, { "type": "int32", "name": "ThreadToExecuteOn", "description": "" } ]
FThreadInfo
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/Threads.h
TraceServices
struct FThreadInfo
[ { "type": "const TCHAR \u0004...", "name": "GroupName", "description": "" }, { "type": "uint32", "name": "Id", "description": "" }, { "type": "const TCHAR \u0004...", "name": "Name", "description": "" } ]
FTimeRegion
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/Regions.h
TraceServices
struct FTimeRegion
[ { "type": "double", "name": "BeginTime", "description": "" }, { "type": "int32", "name": "Depth", "description": "" }, { "type": "double", "name": "EndTime", "description": "" }, { "type": "const TCHAR \u0004...", "name": "Text", "description": "" } ]
FTimingProfilerAggregatedStats
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TimingProfiler.h
TraceServices
struct FTimingProfilerAggregatedStats
[ { "type": "double", "name": "AverageExclusiveTime", "description": "" }, { "type": "double", "name": "AverageInclusiveTime", "description": "" }, { "type": "uint64", "name": "InstanceCount", "description": "" }, { "type": "double", "name": "MaxExclusiveTime", "description": "" }, { "type": "double", "name": "MaxInclusiveTime", "description": "" }, { "type": "double", "name": "MedianExclusiveTime", "description": "" }, { "type": "double", "name": "MedianInclusiveTime", "description": "" }, { "type": "double", "name": "MinExclusiveTime", "description": "" }, { "type": "double", "name": "MinInclusiveTime", "description": "" }, { "type": "constFTimingPr...", "name": "Timer", "description": "" }, { "type": "double", "name": "TotalExclusiveTime", "description": "" }, { "type": "double", "name": "TotalInclusiveTime", "description": "" } ]
FTimingProfilerButterflyNode
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TimingProfiler.h
TraceServices
struct FTimingProfilerButterflyNode
[ { "type": "TArray<FTiming...", "name": "Children", "description": "" }, { "type": "uint64", "name": "Count", "description": "" }, { "type": "double", "name": "ExclusiveTime", "description": "" }, { "type": "double", "name": "InclusiveTime", "description": "" }, { "type": "constFTimingPr...", "name": "Parent", "description": "" }, { "type": "constFTimingPr...", "name": "Timer", "description": "" } ]
FTimingProfilerEvent
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TimingProfiler.h
TraceServices
struct FTimingProfilerEvent
[ { "type": "uint32", "name": "TimerIndex", "description": "" } ]
InvalidTimestamp
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TasksProfiler.h
Thread -ENamedThreads::AnyThread), task priority, thread priority (in case of a worker thread), and queue index (in case of a named thread - main queue or local queue). See ENamedThreads to split the info into separate fields
TraceServices
static constexpr double InvalidTimestamp = 0.0;
[]
FTimingProfilerTimer
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TimingProfiler.h
TraceServices
struct FTimingProfilerTimer
[ { "type": "union TraceServ...", "name": "@13181", "description": "" }, { "type": "const TCHAR \u0004...", "name": "File", "description": "" }, { "type": "uint32", "name": "Id", "description": "" }, { "type": "uint32: 1", "name": "IsGpuTimer", "description": "" }, { "type": "uint32: 24", "name": "Line", "description": "" }, { "type": "uint32", "name": "LineAndFlags", "description": "" }, { "type": "const TCHAR \u0004...", "name": "Name", "description": "" } ]
EType
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
enum EType { Int64, Double, String, }
[]
FTraceSessionMetadata
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
struct FTraceSessionMetadata
[ { "type": "union TraceServ...", "name": "@13174", "description": "" }, { "type": "double", "name": "DoubleValue", "description": "" }, { "type": "int64", "name": "Int64Value", "description": "" }, { "type": "FName", "name": "Name", "description": "" }, { "type": "FString", "name": "StringValue", "description": "" }, { "type": "EType", "name": "Type", "description": "" } ]
FWaitingForTasks
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TasksProfiler.h
TraceServices
struct FWaitingForTasks
[ { "type": "double", "name": "FinishedTimestamp", "description": "" }, { "type": "double", "name": "StartedTimestamp", "description": "" }, { "type": "TArray<TaskTra...", "name": "Tasks", "description": "" } ]
IAllocationsProvider::BeginRead
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
void BeginRead() const
[]
IAllocationsProvider::CancelQuery
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
void CancelQuery ( [FQueryHandle](API\Developer\TraceServices\TraceServices\Model\IAllocationsProvider\FQueryHandle) Query ) const
[]
IAllocationsProvider::EndRead
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
void EndRead() const
[]
IAllocationsProvider::EnumerateAllocEventsTimeline
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
Enumerates the Alloc Events timeline points in the inclusive index interval [StartIndex, EndIndex].
TraceServices
void EnumerateAllocEventsTimeline ( int32 StartIndex, int32 EndIndex, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(double Time, double Duration, uint32Value)> Callback ) const
[]
IAllocationsProvider::EnumerateFreeEventsTimeline
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
Enumerates the Free Events timeline points in the inclusive index interval [StartIndex, EndIndex].
TraceServices
void EnumerateFreeEventsTimeline ( int32 StartIndex, int32 EndIndex, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(double Time, double Duration, uint32Value)> Callback ) const
[]
IAllocationsProvider::EnumerateHeaps
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
void EnumerateHeaps ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(HeapId Id, const [FHeapSpec](API\Developer\TraceServices\TraceServices\Model\IAllocationsProvider\FHeapSpec) &)> Callback ) const
[]
IAllocationsProvider::EnumerateMaxLiveAllocationsTimeline
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
Enumerates the Max Live Allocations timeline points in the inclusive index interval [StartIndex, EndIndex].
TraceServices
void EnumerateMaxLiveAllocationsTimeline ( int32 StartIndex, int32 EndIndex, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(double Time, double Duration, uint32Value)> Callback ) const
[]
IAllocationsProvider::EnumerateMaxTotalAllocatedMemoryTimeline
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
Enumerates the Max Total Allocated Memory timeline points in the inclusive index interval [StartIndex, EndIndex].
TraceServices
void EnumerateMaxTotalAllocatedMemoryTimeline ( int32 StartIndex, int32 EndIndex, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(double Time, double Duration, uint64Value)> Callback ) const
[]
IAllocationsProvider::EnumerateMinLiveAllocationsTimeline
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
Enumerates the Min Live Allocations timeline points in the inclusive index interval [StartIndex, EndIndex].
TraceServices
void EnumerateMinLiveAllocationsTimeline ( int32 StartIndex, int32 EndIndex, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(double Time, double Duration, uint32Value)> Callback ) const
[]
IAllocationsProvider::EnumerateMinTotalAllocatedMemoryTimeline
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
Enumerates the Min Total Allocated Memory timeline points in the inclusive index interval [StartIndex, EndIndex].
TraceServices
void EnumerateMinTotalAllocatedMemoryTimeline ( int32 StartIndex, int32 EndIndex, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(double Time, double Duration, uint64Value)> Callback ) const
[]
IAllocationsProvider::EnumerateRootHeaps
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
void EnumerateRootHeaps ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(HeapId Id, const [FHeapSpec](API\Developer\TraceServices\TraceServices\Model\IAllocationsProvider\FHeapSpec) &)> Callback ) const
[]
IAllocationsProvider::EnumerateTags
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
Enumerates the discovered tags.
TraceServices
void EnumerateTags ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(const TCHAR *, const TCHAR *, [TagIdType](API\Developer\TraceServices\TraceServices\Model\TagIdType), [TagIdType](API\Developer\TraceServices\TraceServices\Model\TagIdType))> Callback ) const
[]
EQueryRule
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
Allocation query rules. The enum uses the following naming convention: A, B, C, D = time markers a = time when "alloc" event occurs f = time when "free" event occurs (can be infinite) Ex.: "AaBf" means "all memory allocations allocated between time A and time B and freed after time B".
TraceServices
enum EQueryRule { aAf, afA, Aaf, aAfB, AaBf, aAfaBf, AfB, AaB, AafB, aABf, AaBCf, AaBfC, aABfC, AaBCfD, }
[]
EQueryStatus
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
enum EQueryStatus { Unknown, Done, Working, Available, }
[]
IAllocationsProvider::FAllocation::GetAlignment
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
uint32 GetAlignment&40;&41; const
[]
IAllocationsProvider::FAllocation::GetCallstackId
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
uint32 GetCallstackId&40;&41; const
[]
IAllocationsProvider::FAllocation::GetEndEventIndex
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
uint32 GetEndEventIndex&40;&41; const
[]
IAllocationsProvider::FAllocation::GetEndTime
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
double GetEndTime&40;&41; const
[]
IAllocationsProvider::FAllocation::GetFreeCallstackId
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
uint32 GetFreeCallstackId&40;&41; const
[]
IAllocationsProvider::FAllocation::GetMetadataId
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
uint32 GetMetadataId&40;&41; const
[]
IAllocationsProvider::FAllocation::GetRootHeap
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
HeapId GetRootHeap&40;&41; const
[]
IAllocationsProvider::FAllocation::GetSize
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
uint64 GetSize&40;&41; const
[]
IAllocationsProvider::FAllocation::GetStartEventIndex
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
uint32 GetStartEventIndex&40;&41; const
[]
IAllocationsProvider::FAllocation::GetStartTime
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
double GetStartTime&40;&41; const
[]
IAllocationsProvider::FAllocation::GetAddress
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
uint64 GetAddress&40;&41; const
[]
IAllocationsProvider::FAllocation::GetTag
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
TagIdType GetTag&40;&41; const
[]
IAllocationsProvider::FAllocation::IsHeap
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
bool IsHeap&40;&41; const
[]
IAllocationsProvider::FAllocation::GetThreadId
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
uint32 GetThreadId&40;&41; const
[]
FAllocation
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
struct FAllocation
[]
IAllocationsProvider::FAllocations::Get
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
const FAllocation &42; Get &40; uint32 Index &41; const
[]
IAllocationsProvider::FAllocations::Num
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
uint32 Num&40;&41; const
[]
IAllocationsProvider::FAllocations::operator delete
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
void operator delete &40; void &42; Address &41;
[]
FAllocations
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
class FAllocations
[]
FHeapSpec
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
struct FHeapSpec
[ { "type": "TArray<FHeapSp...", "name": "Children", "description": "" }, { "type": "EMemoryTraceHea...", "name": "Flags", "description": "" }, { "type": "HeapId", "name": "Id", "description": "" }, { "type": "const TCHAR \u0004...", "name": "Name", "description": "" }, { "type": "FHeapSpec*", "name": "Parent", "description": "" } ]
FQueryHandle
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
typedef UPTRINT FQueryHandle
[]
FQueryParams
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
struct FQueryParams
[ { "type": "EQueryRule", "name": "Rule", "description": "" }, { "type": "double", "name": "TimeA", "description": "" }, { "type": "double", "name": "TimeB", "description": "" }, { "type": "double", "name": "TimeC", "description": "" }, { "type": "double", "name": "TimeD", "description": "" } ]
FQueryResult
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
typedef [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< const [FAllocations](API\Developer\TraceServices\TraceServices\Model\IAllocationsProvider\FAllocations) > FQueryResult
[]
IAllocationsProvider::FQueryStatus::NextResult
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
FQueryResult NextResult&40;&41; const
[]
FQueryStatus
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
struct FQueryStatus
[ { "type": "UPTRINT", "name": "Handle", "description": "" }, { "type": "EQueryStatus", "name": "Status", "description": "" } ]
IAllocationsProvider::GetTagFullPath
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
const TCHAR * GetTagFullPath ( [TagIdType](API\Developer\TraceServices\TraceServices\Model\TagIdType) Tag ) const
[]
IAllocationsProvider::GetTagName
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
Returns the display name of the specified LLM tag. Lifetime of returned string matches the session lifetime.
TraceServices
const TCHAR * GetTagName ( [TagIdType](API\Developer\TraceServices\TraceServices\Model\TagIdType) Tag ) const
[]
IAllocationsProvider::GetTimelineIndexRange
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
Returns the inclusive index range [StartIndex, EndIndex] for a time range [StartTime, EndTime].Indexvalues are in range { -1, 0, .. , N-1, N }, where N =GetTimelineNumPoints().
TraceServices
void GetTimelineIndexRange ( double StartTime, double EndTime, int32 & StartIndex, int32 & EndIndex ) const
[]
IAllocationsProvider::GetTimelineNumPoints
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
Returns the number of points in each timeline (Min/Max Total Allocated Memory, Min/Max Live Allocations, Total Alloc Events, Total Free Events).
TraceServices
int32 GetTimelineNumPoints() const
[]
IAllocationsProvider::IsInitialized
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
bool IsInitialized() const
[]
IAllocationsProvider::PollQuery
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
const [FQueryStatus](API\Developer\TraceServices\TraceServices\Model\IAllocationsProvider\FQueryStatus) PollQuery ( [FQueryHandle](API\Developer\TraceServices\TraceServices\Model\IAllocationsProvider\FQueryHandle) Query ) const
[]
IAllocationsProvider::ReadAccessCheck
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
void ReadAccessCheck() const
[]
IAllocationsProvider::StartQuery
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
[FQueryHandle](API\Developer\TraceServices\TraceServices\Model\IAllocationsProvider\FQueryHandle) StartQuery ( const [FQueryParams](API\Developer\TraceServices\TraceServices\Model\IAllocationsProvider\FQueryParams) & Params ) const
[]
IAllocationsProvider::~IAllocationsProvider
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
virtual ~IAllocationsProvider()
[]
IAllocationsProvider
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
TraceServices
class IAllocationsProvider : public [TraceServices::IProvider](API\Developer\TraceServices\TraceServices\Model\IProvider)
[]
BlockSizeBytes
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisCache.h
Block size in bytes
TraceServices
static constexpr uint64 BlockSizeBytes = 8 * 1024;
[]
IAnalysisCache::CreateBlocks
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisCache.h
Create blocks of tracked memory. The requested blocks form a contiguous memory range. The block written to disk when no more references are alive. Buffer mapping to the blocks. If the cache id is invalid an empty buffer is returned.
TraceServices
[FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) CreateBlocks ( [FCacheId](API\Developer\TraceServices\TraceServices\Model\FCacheId) CacheId, uint32 Count )
[]
IAnalysisCache::GetBlocks
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisCache.h
Load blocks into memory. The requested range of blocks will be loaded into a contiguous memory range. Buffer mapping to the blocks. If the block range is invalid the buffer is empty.
TraceServices
[FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) GetBlocks ( [FCacheId](API\Developer\TraceServices\TraceServices\Model\FCacheId) CacheId, uint32 BlockIndexStart, uint32 BlockCount )
[]
IAnalysisCache::GetCacheId
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisCache.h
Returns the unique id for a named entry. If the entry does not yet exists and new id is reserved. A valid index for the identifier
TraceServices
[FCacheId](API\Developer\TraceServices\TraceServices\Model\FCacheId) GetCacheId ( const TCHAR * Name, uint16 Flags )
[]
IAnalysisCache::GetUserData
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisCache.h
Gets a pointer to the user data a given cache id. The owner of the cache id is able to store arbitrary data which does not fit as block data, for example element counts. The user can write to this memory at any point during the session. The block is stored to disk at the end of the session. A valid memory view of the user data block, an empty view if the index was not found.
TraceServices
FMutableMemoryView GetUserData ( [FCacheId](API\Developer\TraceServices\TraceServices\Model\FCacheId) CacheId )
[]
IAnalysisCache::~IAnalysisCache
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisCache.h
TraceServices
virtual ~IAnalysisCache()
[]
IAnalysisCache
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisCache.h
The container classesTraceServices::TCachedPagedArrayorTraceServices::FCachedStringStoreare provided as user facing abstractions on top of the cache.
TraceServices
class IAnalysisCache
[]
IAnalysisSession::AddAnalyzer
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
void AddAnalyzer ( [UE::Trace::IAnalyzer](API\Developer\TraceAnalysis\Trace\IAnalyzer) * Analyzer )
[]
IAnalysisSession::AddMetadata
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
void AddMetadata ( [FName](API\Runtime\Core\UObject\FName) InName, int64 InValue )
[]
IAnalysisSession::AddMetadata
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
void AddMetadata ( [FName](API\Runtime\Core\UObject\FName) InName, double InValue )
[]
IAnalysisSession::AddMetadata
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
void AddMetadata ( [FName](API\Runtime\Core\UObject\FName) InName, [FString](API\Runtime\Core\Containers\FString) InValue )
[]
IAnalysisSession::AddProvider
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
void AddProvider ( const [FName](API\Runtime\Core\UObject\FName) & Name, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IProvider](API\Developer\TraceServices\TraceServices\Model\IProvider) > Provider, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IEditableProvider](API\Developer\TraceServices\TraceServices\Model\IEditableProvider) > EditableProvider )
[]
IAnalysisSession::BeginEdit
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
void BeginEdit()
[]
IAnalysisSession::BeginRead
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
void BeginRead() const
[]
IAnalysisSession::DrainPendingMessages
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
Moves pending messages to the return array.
TraceServices
[TArray](API\Runtime\Core\Containers\TArray)< [FAnalysisMessage](API\Developer\TraceServices\TraceServices\Model\FAnalysisMessage) > DrainPendingMessages()
[]
IAnalysisSession::EditProvider
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
template<typename ProviderType> ProviderType * EditProvider ( const [FName](API\Runtime\Core\UObject\FName) & Name )
[]
IAnalysisSession::EndEdit
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
void EndEdit()
[]
IAnalysisSession::EndRead
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
void EndRead() const
[]
IAnalysisSession::EnumerateMetadata
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
void EnumerateMetadata ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(const [FTraceSessionMetadata](API\Developer\TraceServices\TraceServices\Model\FTraceSessionMetadata) &Metadata)> Callback ) const
[]
IAnalysisSession::GetCache
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
[IAnalysisCache](API\Developer\TraceServices\TraceServices\Model\IAnalysisCache) & GetCache()
[]
IAnalysisSession::GetDurationSeconds
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
double GetDurationSeconds() const
[]
IAnalysisSession::GetLinearAllocator
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
[ILinearAllocator](API\Developer\TraceServices\TraceServices\Containers\ILinearAllocator) & GetLinearAllocator()
[]
IAnalysisSession::GetLog
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
Deprecated* No longer used.
TraceServices
[FMessageLog](API\Runtime\Core\Logging\FMessageLog) * GetLog() const
[]
IAnalysisSession::GetMetadataCount
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
uint32 GetMetadataCount() const
[]
IAnalysisSession::GetName
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
const TCHAR * GetName() const
[]
IAnalysisSession::GetNumPendingMessages
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
Get the number of pending messages. Can be called without lock
TraceServices
uint32 GetNumPendingMessages() const
[]
IAnalysisSession::GetTraceId
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
uint32 GetTraceId() const
[]
IAnalysisSession::IsAnalysisComplete
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
bool IsAnalysisComplete() const
[]
IAnalysisSession::ReadAccessCheck
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
void ReadAccessCheck() const
[]
IAnalysisSession::ReadProvider
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
template<typename ProviderType> const ProviderType * ReadProvider ( const [FName](API\Runtime\Core\UObject\FName) & Name ) const
[]
IAnalysisSession::Stop
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
void Stop ( bool bAndWait ) const
[]
IAnalysisSession::StoreString
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
const TCHAR * StoreString ( const TCHAR * String )
[]
IAnalysisSession::StoreString
/Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisSession.h
TraceServices
const TCHAR * StoreString ( const FStringView & String )
[]