Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. TraceServices

TraceServices

API > API/Developer

   
Name TraceServices
Type Developer
Location /Engine/Source/Developer/TraceServices/
Module Build Rules TraceServices.Build.cs

Classes

Name Remarks
EnumerateAsyncAlgoritm  
FCancellationToken  
FEnumerateAsyncTask  
FMetadataSchema  
FNetProfilerBunchInfo  
FProviderLock Utility class to implement the read/write lock for a provider.
FRegionLane  
FSlabAllocator  
FTableImportService  
FTableMergeService  
TCachedPagedArray A typed paged array allowing persistent storage of the data.
TCachedStringStore A deduplicating persistent string store.
TIntervalTimeline  
TMonotonicTimeline  
TPagedArray  
TPagedArrayIterator  
TPointTimeline  
TVariablePagedArray  
TVariablePagedArrayIterator  

Structs

Name Remarks
FAnalysisMessage  
FAnalysisSessionEditScope  
FAnalysisSessionReadScope  
FAsyncEnumerateTaskData  
FBookmark  
FCallstack  
FCaptureInfo  
FChannelEntry  
FClassInfo  
FContextSwitch  
FCpuCoreEvent  
FCpuCoreInfo  
FCreateAggregationParams  
FCreateButterflyParams  
FDetailLevel  
FDetailLevelDepthState  
FDetailLevelInsertionState  
FEventInfoStackEntry  
FEventScopeEntry  
FEventScopeEntryPage  
FEventStackEntry  
FExportsTableRow  
FFileActivity  
FFileInfo  
FFrame  
FGpuFenceWrapper  
FGpuQueueInfo  
FGpuSignalFence  
FGpuWaitFence  
FIntervalTimelineDefaultSettings  
FLaneEnumeration  
FLoadRequest  
FLoadTimeProfilerAggregatedStats  
FLoadTimeProfilerCpuEvent  
FLogCategoryInfo  
FLogMessageInfo  
FMemoryTagInfo  
FMemoryTagSample  
FMemoryTagSetInfo  
FMemoryTrackerInfo  
FMetadataSpec  
FModule Represents information about a module (engine/game/system dll or monolithic binary) and how debug information has been loaded.
FModuleInfo  
FModuleInfoEx  
FMonotonicTimelineDefaultSettings  
FNetProfilerAggregatedStats  
FNetProfilerAggregatedStatsCounterStats  
FNetProfilerConnection  
FNetProfilerContentEvent  
FNetProfilerEventType This is our event type separate per level as the same name might be used on different levels.
FNetProfilerFrame  
FNetProfilerGameInstance  
FNetProfilerLifeTime  
FNetProfilerName  
FNetProfilerObjectInstance Struct FNetProfilerProtocol
FNetProfilerPacket  
FNetProfilerStats  
FNetProfilerStatsCounterType  
FPackageData  
FPackageExportInfo  
FPackageInfo  
FPackagesTableRow  
FPackageSummaryInfo  
FPointTimelineDefaultSettings  
FProviderEditScopeLock  
FProviderReadScopeLock  
FRegionCategory  
FRegionTimer  
FRequestsTableRow  
FResolvedSymbol Represent a resolved symbol.
FScreenshot  
FSessionInfo  
FStackFrame  
FStackSampleFrame  
FStackSampleThread  
FStringDefinition  
FTableDiffCallbackParams  
FTableImportCallbackParams  
FTaskInfo Task biography
FThreadInfo  
FTimeRegion  
FTimingProfilerAggregatedStats  
FTimingProfilerButterflyNode  
FTimingProfilerEvent  
FTimingProfilerTimer  
FTraceSessionMetadata  
FWaitingForTasks  
TPagedArrayPage  
TVariablePagedArrayPage In a page, used items are [ItemOffset .. ItemOffset + ItemCount - 1].
TVariablePagedArrayPageGroup  

Interfaces

Name Remarks
IAllocationsProvider  
IAnalysisCache Analysis cache
IAnalysisService  
IAnalysisSession  
IBookmarkProvider  
ICallstacksProvider  
IChannelProvider  
IContextSwitchesProvider  
ICookProfilerProvider  
ICounter  
ICounterProvider  
ICsvProfilerProvider  
IDefinitionProvider Allows users to publish "definitions", structs representing a definition event.
IDiagnosticsProvider  
IEditableBookmarkProvider The interface to a provider that can consume mutations of bookmark events from a session.
IEditableCookProfilerProvider  
IEditableCounter An interface that can consume mutations of the state of a counter.
IEditableCounterProvider The interface to a provider that can consume mutations of counter events from a session.
IEditableLogProvider  
IEditableMetadataProvider  
IEditableProvider  
IEditableRegionProvider The interface to a provider that can consume mutations of region events from a session.
IEditableThreadProvider An interface that can consume thread related events from a session.
IEditableTimeline An interface that can consume timed serial events (a timeline).
IEditableTimingProfilerProvider  
IFileActivityProvider  
IFrameProvider  
ILinearAllocator  
ILoadTimeProfilerProvider  
ILogProvider  
IMemoryProvider  
IMetadataProvider  
IModule  
IModuleProvider  
IModuleService  
INetProfilerProvider What queries do we need?
IProvider  
IRegionProvider  
IRegionTimeline Sorts a set of Timing Regions into a stack of individual lanes without overlaps for display
IResolvedSymbolFilter  
IScreenshotProvider  
IStackSamplesProvider  
IStringStore  
ITable  
ITableImportData  
ITableLayout  
ITableReader  
ITasksProvider Query interface to tasks info
IThreadProvider  
ITimeline  
ITimingProfilerButterfly  
ITimingProfilerProvider  
ITimingProfilerTimerReader  
ITraceServicesModule  
IUntypedTable  
IUntypedTableReader  

Typedefs

Name Type Remarks Include Path
FCachedStringStore TCachedStringStore< WIDECHAR >   Common/CachedStringStore.h
FCachedStringStoreAnsi TCachedStringStore< ANSICHAR >   Common/CachedStringStore.h
FCacheId uint32 A unique id for a named cache entry. TraceServices/Model/AnalysisCache.h
FMemoryTagId int64   TraceServices/Model/Memory.h
FMemoryTagSetId int32   TraceServices/Model/Memory.h
FMemoryTrackerId int32   TraceServices/Model/Memory.h
FNetProfilerNameIndexType uint32 Mirror from FNetDebugNameId on the runtime side. TraceServices/Model/NetProfiler.h
FNetProfilerTimeStamp double   TraceServices/Model/NetProfiler.h
FSegmentIterator TArrayView< FMemoryView > An iterator for segments TraceServices/Model/AnalysisCache.h
FStackSampleTimeline ITimeline< FTimingProfilerEvent >   TraceServices/Model/StackSamples.h
ITimingProfilerEditableTimeline IEditableTimeline< FTimingProfilerEvent >   TraceServices/Model/TimingProfiler.h
ITimingProfilerTimeline ITimeline< FTimingProfilerEvent >   TraceServices/Model/TimingProfiler.h
TagIdType uint32 Id type for tags. TraceServices/Model/AllocationsProvider.h

Enums

Public

Name Remarks
TraceServices::ECacheFlags Flags defining the behaviour of a cache entry
TraceServices::EContextSwitchEnumerationResult TraceAnalysis.
TraceServices::ECounterDisplayHint TraceAnalysis.
TraceServices::ECounterOpType TraceAnalysis.
TraceServices::EEnumerateResult TraceAnalysis.
TraceServices::EEventEnumerate TraceAnalysis.
TraceServices::EEventSortOrder TraceAnalysis.
TraceServices::EFileActivityType TraceAnalysis.
TraceServices::EGpuFenceType TraceAnalysis.
TraceServices::ELoadTimeProfilerObjectEventType TraceAnalysis.
TraceServices::EModuleStatus TraceAnalysis.
TraceServices::ENetProfilerAggregationMode TraceAnalysis.
TraceServices::ENetProfilerChannelCloseReason Mirrored from EChannelCloseReason on the runtime side.
TraceServices::ENetProfilerConnectionMode TraceAnalysis.
TraceServices::ENetProfilerConnectionState Mirrored from EConnectionState on the runtime side.
TraceServices::ENetProfilerDeliveryStatus TraceAnalysis.
TraceServices::ENetProfilerStatsCounterType This must be kept in sync with ENetTraceStatsCounterType in NetTrace.h.
TraceServices::EResolvedSymbolFilterStatus TraceAnalysis.
TraceServices::ESymbolQueryResult Result of a query.
TraceServices::ETableColumnDisplayHint TraceAnalysis.
TraceServices::ETableColumnType TraceAnalysis.
TraceServices::ETableDiffResult TraceAnalysis.
TraceServices::ETableImportResult TraceAnalysis.
TraceServices::ETaskEnumerationOption TraceAnalysis.
TraceServices::ETaskEnumerationResult TraceAnalysis.
TraceServices::ETimingProfilerTimerType TraceAnalysis.

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedPtr< IAnalysisSession > TraceServices::CreateAnalysisSession ( uint32 InTraceId,
const TCHAR* InSessionName,
TUniquePtr< UE::Trace::IInDataStream >&& InDataStream
)

 Create an IAnalysisSession object for external analysis. TraceServices/AnalyzerFactories.h  

TSharedPtr< UE::Trace::IAnalyzer > TraceServices::CreateBookmarksAnalyzer ( IAnalysisSession& InSession,
IEditableBookmarkProvider& InEditableBookmarkProvider
)

 Create an IAnalyzer object for analyzing bookmark events. TraceServices/AnalyzerFactories.h  

TSharedPtr< UE::Trace::IAnalyzer > TraceServices::CreateCountersAnalyzer ( IAnalysisSession& InSession,
IEditableCounterProvider& InEditableCounterProvider
)

 Create an IAnalyzer object for analyzing counter events. TraceServices/AnalyzerFactories.h  

TSharedPtr< UE::Trace::IAnalyzer > TraceServices::CreateCpuProfilerAnalyzer ( IAnalysisSession& InSession,
IEditableTimingProfilerProvider& InEditableTimingProfilerProvider,
IEditableThreadProvider& InEditableThreadProvider
)

 Create an IAnalyzer object for external analysis. TraceServices/AnalyzerFactories.h  

TArrayView< const uint8 > TraceServices::FTraceAnalyzerUtils::LegacyAttachmentArray ( const ANSICHAR* FieldName,
const UE::Trace::IAnalyzer::FOnEventContext& Context
)

   TraceServices/Utils.h  

FString TraceServices::FTraceAnalyzerUtils::LegacyAttachmentString ( const ANSICHAR* FieldName,
const UE::Trace::IAnalyzer::FOnEventContext& Context
)

   TraceServices/Utils.h  

const ItemType * TraceServices::GetData ( const TPagedArrayPage< ItemType >& Page
)

   Common/PagedArray.h  

const PageType * TraceServices::GetData ( const TPagedArray< ItemType, PageType >& PagedArray
)

   Common/PagedArray.h  

const ItemType * TraceServices::GetData ( const TVariablePagedArrayPage< ItemType >& Page
)

   Common/VariablePagedArray.h  

FInt32Interval TraceServices::GetElementRangeOverlappingGivenRange ( const TPagedArray< ItemType, PageType >& PagedArray,
double StartTime,
double EndTime,
TFunctionRef< double(const ItemType&)> ItemStartProjection,
TFunctionRef< double(const ItemType&)> ItemEndProjection
)

 Use binary search to find the first and last element inside a TPagedArray that overlaps a given input interval. Common/PagedArray.h  

const ItemType * TraceServices::GetFirstItem ( const TPagedArrayPage< ItemType >& Page
)

   Common/PagedArray.h  

const ItemType * TraceServices::GetFirstItem ( const TVariablePagedArrayPage< ItemType >& Page
)

   Common/VariablePagedArray.h  

const ItemType * TraceServices::GetLastItem ( const TPagedArrayPage< ItemType >& Page
)

   Common/PagedArray.h  

const ItemType * TraceServices::GetLastItem ( const TVariablePagedArrayPage< ItemType >& Page
)

   Common/VariablePagedArray.h  

SIZE_T TraceServices::GetNum ( const TPagedArrayPage< ItemType >& Page
)

   Common/PagedArray.h  

SIZE_T TraceServices::GetNum ( const TPagedArray< ItemType, PageType >& PagedArray
)

   Common/PagedArray.h  

SIZE_T TraceServices::GetNum ( const TVariablePagedArrayPage< ItemType >& Page
)

   Common/VariablePagedArray.h  

const TCHAR * TraceServices::ModuleStatusToString ( EModuleStatus Result
)

   TraceServices/Model/Modules.h  

decltype(GetNum(PagedArray)) TraceServices::PagedArrayAlgo::BinarySearchClosest ( const TPagedArray< ItemType, PageType >& PagedArray,
const ItemType& Value
)

   Common/PagedArray.h  

decltype(GetNum(PagedArray)) TraceServices::PagedArrayAlgo::BinarySearchClosest ( const TPagedArray< ItemType, PageType >& PagedArray,
const ItemType& Value,
SortPredicateType SortPredicate
)

 Performs binary search, resulting in position of the first element closest to Value. Common/PagedArray.h  

decltype(GetNum(PagedArray)) TraceServices::PagedArrayAlgo::BinarySearchClosestBy ( const TPagedArray< ItemType, PageType >& PagedArray,
const ValueType& Value,
ProjectionType Projection
)

   Common/PagedArray.h  

decltype(GetNum(PagedArray)) TraceServices::PagedArrayAlgo::BinarySearchClosestBy ( const TPagedArray< ItemType, PageType >& PagedArray,
const ValueType& Value,
ProjectionType Projection,
SortPredicateType SortPredicate
)

 Performs binary search, resulting in position of the first element with projected value closest to Value. Common/PagedArray.h  

decltype(GetNum(PagedArray)) TraceServices::PagedArrayAlgo::LowerBound ( const TPagedArray< ItemType, PageType >& PagedArray,
const ItemType& Value
)

   Common/PagedArray.h  

decltype(GetNum(PagedArray)) TraceServices::PagedArrayAlgo::LowerBound ( const TPagedArray< ItemType, PageType >& PagedArray,
const ItemType& Value,
SortPredicateType SortPredicate
)

 Performs binary search, resulting in position of the first element >= Value. Common/PagedArray.h  

decltype(GetNum(PagedArray)) TraceServices::PagedArrayAlgo::LowerBoundBy ( const TPagedArray< ItemType, PageType >& PagedArray,
const ValueType& Value,
ProjectionType Projection
)

   Common/PagedArray.h  

decltype(GetNum(PagedArray)) TraceServices::PagedArrayAlgo::LowerBoundBy ( const TPagedArray< ItemType, PageType >& PagedArray,
const ValueType& Value,
ProjectionType Projection,
SortPredicateType SortPredicate
)

 Performs binary search, resulting in position of the first element with projected value >= Value. Common/PagedArray.h  

decltype(GetNum(PagedArray)) TraceServices::PagedArrayAlgo::UpperBound ( const TPagedArray< ItemType, PageType >& PagedArray,
const ItemType& Value
)

   Common/PagedArray.h  

decltype(GetNum(PagedArray)) TraceServices::PagedArrayAlgo::UpperBound ( const TPagedArray< ItemType, PageType >& PagedArray,
const ItemType& Value,
SortPredicateType SortPredicate
)

 Performs binary search, resulting in position of the first element > Value. Common/PagedArray.h  

decltype(GetNum(PagedArray)) TraceServices::PagedArrayAlgo::UpperBoundBy ( const TPagedArray< ItemType, PageType >& PagedArray,
const ValueType& Value,
ProjectionType Projection
)

   Common/PagedArray.h  

decltype(GetNum(PagedArray)) TraceServices::PagedArrayAlgo::UpperBoundBy ( const TPagedArray< ItemType, PageType >& PagedArray,
const ValueType& Value,
ProjectionType Projection,
SortPredicateType SortPredicate
)

 Performs binary search, resulting in position of the first element with projected value > Value. Common/PagedArray.h  

SizeType TraceServices::PagedArrayAlgoImpl::BinarySearchClosestInternal ( const TPagedArray< ItemType, PageType >& PagedArray,
ValueType Value,
ProjectionType Projection,
SortPredicateType SortPredicate
)

 Performs binary search, resulting in position of the first element with projected value closest to Value. Common/PagedArray.h  

SizeType TraceServices::PagedArrayAlgoImpl::LowerBoundInternal ( const TPagedArray< ItemType, PageType >& PagedArray,
const ValueType& Value,
ProjectionType Projection,
SortPredicateType SortPredicate
)

 Performs binary search, resulting in position of the first element with projected value >= Value. Common/PagedArray.h  

SizeType TraceServices::PagedArrayAlgoImpl::UpperBoundInternal ( const TPagedArray< ItemType, PageType >& PagedArray,
const ValueType& Value,
ProjectionType Projection,
SortPredicateType SortPredicate
)

 Performs binary search, resulting in position of the first element with projected value > Value. Common/PagedArray.h  

const TCHAR * TraceServices::QueryResultToString ( ESymbolQueryResult Result
)

 Helper method to get a string representation of the query result. TraceServices/Model/Modules.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page