Navigation
API > API/Plugins > API/Plugins/ActorModifierCore
Profiler class to track modifier usage and performance
| Name | FActorModifierCoreProfiler |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/ActorModifierCore/Source/ActorModifierCore/Public/Modifiers/Profiler/ActorModifierCoreProfiler.h |
| Include Path | #include "Modifiers/Profiler/ActorModifierCoreProfiler.h" |
Syntax
class FActorModifierCoreProfiler : public TSharedFromThis< FActorModifierCoreProfiler >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FActorModifierCoreProfiler
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FActorModifierCoreProfiler() |
Modifiers/Profiler/ActorModifierCoreProfiler.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AverageExecutionTimeName | const FName | Modifiers/Profiler/ActorModifierCoreProfiler.h | |
| ExecutionTimeName | const FName | Modifiers/Profiler/ActorModifierCoreProfiler.h | |
| FrameCountDeltaName | const FName | Modifiers/Profiler/ActorModifierCoreProfiler.h | |
| FrameRateDeltaName | const FName | Modifiers/Profiler/ActorModifierCoreProfiler.h | |
| TotalExecutionTimeName | const FName | Modifiers/Profiler/ActorModifierCoreProfiler.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ExecutionCount | uint64 | Modifiers/Profiler/ActorModifierCoreProfiler.h | ||
| ExecutionTimeStart | uint64 | Modifiers/Profiler/ActorModifierCoreProfiler.h | ||
| FrameCountStart | uint64 | Modifiers/Profiler/ActorModifierCoreProfiler.h | ||
| FrameRateStart | float | Modifiers/Profiler/ActorModifierCoreProfiler.h | ||
| ModifierWeak | TWeakObjectPtr< UActorModifierCoreBase > | Profiled modifier | Modifiers/Profiler/ActorModifierCoreProfiler.h | |
| ProfilerTag | FString | Profiler tag for log | Modifiers/Profiler/ActorModifierCoreProfiler.h | |
| ProfilerType | FName | Type of this profiler object | Modifiers/Profiler/ActorModifierCoreProfiler.h | |
| StructProfilerStats | TSharedPtr< FStructOnScope > | Used to only read profiling stats | Modifiers/Profiler/ActorModifierCoreProfiler.h | |
| TotalExecutionTime | double | Modifiers/Profiler/ActorModifierCoreProfiler.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginProfiling() |
Override this in child classes to measure initial stats, called before modifier is applied | Modifiers/Profiler/ActorModifierCoreProfiler.h | |
virtual void EndProfiling() |
Override this in child classes to measure final stats, called after modifier is applied | Modifiers/Profiler/ActorModifierCoreProfiler.h | |
double GetAverageExecutionTime() |
Modifiers/Profiler/ActorModifierCoreProfiler.h | ||
double GetExecutionTime() |
Modifiers/Profiler/ActorModifierCoreProfiler.h | ||
int64 GetFrameCountDelta() |
Modifiers/Profiler/ActorModifierCoreProfiler.h | ||
float GetFrameRateDelta() |
Modifiers/Profiler/ActorModifierCoreProfiler.h | ||
virtual TSet< FName > GetMainProfilingStats() |
Gets the main stats to display and hide the others | Modifiers/Profiler/ActorModifierCoreProfiler.h | |
| Modifiers/Profiler/ActorModifierCoreProfiler.h | |||
InModifierClass * GetModifier () |
Modifiers/Profiler/ActorModifierCoreProfiler.h | ||
AActor * GetModifierActor() |
Modifiers/Profiler/ActorModifierCoreProfiler.h | ||
FString GetProfilerTag() |
Modifiers/Profiler/ActorModifierCoreProfiler.h | ||
FName GetProfilerType() |
Modifiers/Profiler/ActorModifierCoreProfiler.h | ||
TSharedPtr< FStructOnScope > GetStructProfilerStats() |
Modifiers/Profiler/ActorModifierCoreProfiler.h | ||
double GetTotalExecutionTime() |
Modifiers/Profiler/ActorModifierCoreProfiler.h | ||
virtual void SetupProfilingStats() |
Override this in child classes to setup stats being measured by the profiler | Modifiers/Profiler/ActorModifierCoreProfiler.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ConstructInternal
(
UActorModifierCoreBase* InModifier, |
INTERNAL USE ONLY, called after this class instance is created | Modifiers/Profiler/ActorModifierCoreProfiler.h |