Navigation
API > API/Developer > API/Developer/TraceServices
An interface that can consume timeline CpuProfiler events from a session.
| Name | IEditableTimingProfilerProvider |
| Type | class |
| Header File | /Engine/Source/Developer/TraceServices/Public/TraceServices/Model/TimingProfiler.h |
| Include Path | #include "TraceServices/Model/TimingProfiler.h" |
Syntax
class IEditableTimingProfilerProvider : public TraceServices::IEditableProvider
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IEditableTimingProfilerProvider() |
TraceServices/Model/TimingProfiler.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint32 AddCpuTimer
(
FStringView Name, |
Adds/registers a new CPU timer. | TraceServices/Model/TimingProfiler.h | |
virtual void AddGpuQueue
(
uint32 QueueId, |
Adds a new GPU queue. | TraceServices/Model/TimingProfiler.h | |
virtual void AddGpuSignalFence
(
uint32 QueueId, |
Adds a new GPU signal fence to a queue. | TraceServices/Model/TimingProfiler.h | |
virtual uint32 AddGpuTimer
(
FStringView Name, |
Adds/registers a new GPU timer. | TraceServices/Model/TimingProfiler.h | |
virtual void AddGpuWaitFence
(
uint32 QueueId, |
Adds a new GPU wait fence to a queue. | TraceServices/Model/TimingProfiler.h | |
uint32 AddMetadata
(
uint32 OriginalTimerId, |
Adds metadata to a CPU or GPU timer. | TraceServices/Model/TimingProfiler.h | |
virtual uint32 AddMetadataSpec
(
FMetadataSpec&& Metadata |
Adds a metadata spec to storage. | TraceServices/Model/TimingProfiler.h | |
virtual uint32 AddVerseTimer
(
FStringView Name, |
Adds/registers a new Verse timer. | TraceServices/Model/TimingProfiler.h | |
IEditableTimeline< FTimingProfilerEvent > & GetCpuThreadEditableTimeline
(
uint32 ThreadId |
Gets an object to receive ordered timeline events for a CPU thread. | TraceServices/Model/TimingProfiler.h | |
TArrayView< uint8 > GetEditableMetadata
(
uint32 MetadataTimerId |
Gets metadata by id. | TraceServices/Model/TimingProfiler.h | |
virtual IEditableTimeline< FTimingProfilerEvent > * GetGpuQueueEditableTimeline
(
uint32 QueueId |
Gets an object to receive ordered timeline events for a GPU queue. | TraceServices/Model/TimingProfiler.h | |
virtual IEditableTimeline< FTimingProfilerEvent > * GetGpuQueueWorkEditableTimeline
(
uint32 QueueId |
TraceServices/Model/TimingProfiler.h | ||
virtual const ITimingProfilerProvider * GetReadProvider() |
Gets the read provider. | TraceServices/Model/TimingProfiler.h | |
virtual IEditableTimeline< FTimingProfilerEvent > * GetVerseEditableTimeline() |
Gets an object to receive ordered timeline events for the Verse sampling. | TraceServices/Model/TimingProfiler.h | |
virtual void SetMetadata
(
uint32 MetadataTimerId, |
Sets metadata for the specified MetadataTimerId. | TraceServices/Model/TimingProfiler.h | |
virtual void SetMetadata
(
uint32 MetadataTimerId, |
Sets metadata for the specified MetadataTimerId and replaces the OriginialTimerId with a new value. | TraceServices/Model/TimingProfiler.h | |
virtual void SetMetadataSpec
(
uint32 TimerId, |
Sets the metadata spec for an existing timer. | TraceServices/Model/TimingProfiler.h | |
void SetTimerName
(
uint32 TimerId, |
Updates an existing timer with information. Some information is unavailable when it's created. | TraceServices/Model/TimingProfiler.h | |
void SetTimerNameAndLocation
(
uint32 TimerId, |
Updates an existing timer with information. Some information is unavailable when it's created. | TraceServices/Model/TimingProfiler.h |