1. Epic GamesDeveloper
  3. IAllocationsProvider

IAllocationsProvider

API > API/Developer > API/Developer/TraceServices

   
Name IAllocationsProvider
Type class
Header File /Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AllocationsProvider.h
Include Path #include "TraceServices/Model/AllocationsProvider.h"

Syntax

class IAllocationsProvider : public TraceServices::IProvider

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IAllocationsProvider()

   TraceServices/Model/AllocationsProvider.h  

Classes

Name Remarks
FAllocations  

Structs

Name Remarks
FAllocation  
FHeapSpec  
FQueryParams  
FQueryStatus  

Enums

Public

Name Remarks
EQueryRule Allocation query rules.
EQueryStatus  
ETimelineU32  
ETimelineU64  

Typedefs

Name Type Remarks Include Path
FQueryHandle UPTRINT   TraceServices/Model/AllocationsProvider.h
FQueryResult TUniquePtr< const FAllocations >   TraceServices/Model/AllocationsProvider.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CancelQuery ( FQueryHandle Query
) const

   TraceServices/Model/AllocationsProvider.h  

virtual void EnumerateAllocEventsTimeline ( int32 StartIndex,
int32 EndIndex,
TFunctionRef< void(double Time, double Duration, uint32Value)> Callback
) const

   TraceServices/Model/AllocationsProvider.h  

virtual void EnumerateFreeEventsTimeline ( int32 StartIndex,
int32 EndIndex,
TFunctionRef< void(double Time, double Duration, uint32Value)> Callback
) const

   TraceServices/Model/AllocationsProvider.h  

void EnumerateHeaps ( TFunctionRef< void(HeapId Id, const FHeapSpec&)> Callback
) const

   TraceServices/Model/AllocationsProvider.h  

virtual void EnumerateMaxLiveAllocationsTimeline ( int32 StartIndex,
int32 EndIndex,
TFunctionRef< void(double Time, double Duration, uint32Value)> Callback
) const

   TraceServices/Model/AllocationsProvider.h  

virtual void EnumerateMaxTotalAllocatedMemoryTimeline ( int32 StartIndex,
int32 EndIndex,
TFunctionRef< void(double Time, double Duration, uint64Value)> Callback
) const

   TraceServices/Model/AllocationsProvider.h  

virtual void EnumerateMaxTotalCompressedSwapMemoryTimeline ( int32 StartIndex,
int32 EndIndex,
TFunctionRef< void(double Time, double Duration, uint64Value)> Callback
) const

   TraceServices/Model/AllocationsProvider.h  

virtual void EnumerateMaxTotalSwapMemoryTimeline ( int32 StartIndex,
int32 EndIndex,
TFunctionRef< void(double Time, double Duration, uint64Value)> Callback
) const

   TraceServices/Model/AllocationsProvider.h  

virtual void EnumerateMinLiveAllocationsTimeline ( int32 StartIndex,
int32 EndIndex,
TFunctionRef< void(double Time, double Duration, uint32Value)> Callback
) const

   TraceServices/Model/AllocationsProvider.h  

virtual void EnumerateMinTotalAllocatedMemoryTimeline ( int32 StartIndex,
int32 EndIndex,
TFunctionRef< void(double Time, double Duration, uint64Value)> Callback
) const

   TraceServices/Model/AllocationsProvider.h  

virtual void EnumerateMinTotalCompressedSwapMemoryTimeline ( int32 StartIndex,
int32 EndIndex,
TFunctionRef< void(double Time, double Duration, uint64Value)> Callback
) const

   TraceServices/Model/AllocationsProvider.h  

virtual void EnumerateMinTotalSwapMemoryTimeline ( int32 StartIndex,
int32 EndIndex,
TFunctionRef< void(double Time, double Duration, uint64Value)> Callback
) const

   TraceServices/Model/AllocationsProvider.h  

virtual void EnumeratePageInEventsTimeline ( int32 StartIndex,
int32 EndIndex,
TFunctionRef< void(double Time, double Duration, uint32Value)> Callback
) const

   TraceServices/Model/AllocationsProvider.h  

virtual void EnumeratePageOutEventsTimeline ( int32 StartIndex,
int32 EndIndex,
TFunctionRef< void(double Time, double Duration, uint32Value)> Callback
) const

   TraceServices/Model/AllocationsProvider.h  

void EnumerateRootHeaps ( TFunctionRef< void(HeapId Id, const FHeapSpec&)> Callback
) const

   TraceServices/Model/AllocationsProvider.h  

virtual void EnumerateSwapFreeEventsTimeline ( int32 StartIndex,
int32 EndIndex,
TFunctionRef< void(double Time, double Duration, uint32Value)> Callback
) const

   TraceServices/Model/AllocationsProvider.h  

void EnumerateTags ( TFunctionRef< void(const TCHAR*, const TCHAR*, TagIdType, TagIdType)> Callback
) const

 Enumerates the discovered tags. TraceServices/Model/AllocationsProvider.h  

void EnumerateTimeline ( ETimelineU64 Timeline,
int32 StartIndex,
int32 EndIndex,
TFunctionRef< void(double Time, double Duration, uint64Value)> Callback
) const

 Enumerates points (time-value pairs) of a UInt64 timeline, in the inclusive index interval [StartIndex, EndIndex]. TraceServices/Model/AllocationsProvider.h  

void EnumerateTimeline ( ETimelineU32 Timeline,
int32 StartIndex,
int32 EndIndex,
TFunctionRef< void(double Time, double Duration, uint32Value)> Callback
) const

 Enumerates points (time-value pairs) of a UInt32 timeline, in the inclusive index interval [StartIndex, EndIndex]. TraceServices/Model/AllocationsProvider.h  

uint64 GetPlatformPageSize()

   TraceServices/Model/AllocationsProvider.h  

const TCHAR * GetTagFullPath ( TagIdType Tag
) const

   TraceServices/Model/AllocationsProvider.h  

const TCHAR * GetTagName ( TagIdType Tag
) const

 Returns the display name of the specified LLM tag. TraceServices/Model/AllocationsProvider.h  

void GetTimelineIndexRange ( double StartTime,
double EndTime,
int32& StartIndex,
int32& EndIndex
) const

 Returns the inclusive index range [StartIndex, EndIndex] for a time range [StartTime, EndTime]. TraceServices/Model/AllocationsProvider.h  

int32 GetTimelineNumPoints()

 Returns the number of points in each timeline (Min/Max Total Allocated Memory, Min/Max Live Allocations, Total Alloc Events, Total Free Events). TraceServices/Model/AllocationsProvider.h  

bool HasAllocationEvents()

 Returns true if provider has processed at least one Alloc, Free or Heap event. TraceServices/Model/AllocationsProvider.h  

bool HasSwapOpEvents()

 Returns true if provider has processed at least one Swap Op event. TraceServices/Model/AllocationsProvider.h  

bool IsInitialized()

   TraceServices/Model/AllocationsProvider.h  

const FQueryStatus PollQuery ( FQueryHandle Query
) const

   TraceServices/Model/AllocationsProvider.h  

FQueryHandle StartQuery ( const FQueryParams& Params
) const

   TraceServices/Model/AllocationsProvider.h  

Overridden from IProvider

Name Remarks Include Path Unreal Specifiers

void BeginRead()

   TraceServices/Model/AllocationsProvider.h  

void EndRead()

   TraceServices/Model/AllocationsProvider.h  

void ReadAccessCheck()

   TraceServices/Model/AllocationsProvider.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page