Navigation
Unreal Engine C++ API Reference > Developer > TraceInsights > Insights
Inheritance Hierarchy
References
Module | TraceInsights |
Header | /Engine/Source/Developer/TraceInsights/Public/Insights/IUnrealInsightsModule.h |
Include | #include "Insights/IUnrealInsightsModule.h" |
Syntax
class IUnrealInsightsModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)
Remarks
Interface for an Unreal Insights module.
Functions
Type | Name | Description |
---|---|---|
bool | ConnectToStore ( const TCHAR* InStoreHost, uint32 InStorePort ) | Connects to a specified store. |
void | CreateDefaultStore () | Creates the default trace store (for "Browser" mode). |
void | CreateSessionBrowser ( const FCreateSessionBrowserParams&... ) | Called when the application starts in "Browser" mode. |
void | CreateSessionViewer ( bool bAllowDebugTools ) | Called when the application starts in "Viewer" mode. |
bool | Exec ( const TCHAR* Cmd, FOutputDevice& Ar ) | Execute command. |
const FInsig... | FindMajorTabConfig ( const FName& InMajorTabId ) | Finds a major tab config for the specified id. |
FOnRegisterM... | FindMajorTabLayoutExtension ( const FName& InMajorTabId ) | |
TSharedPtr< ... | GetAnalysisSession () | Gets the current analysis session. |
UE::Trace::F... | GetStoreClient () | Gets the store client. |
void | InitializeTesting ( bool InInitAutomationModules, bool InAutoQuit ) | Called to initialize testing in stand alone Insights. |
FOnInsightsM... | OnMajorTabCreated () | Callback invoked when a major tab is created |
FOnRegisterM... | OnRegisterMajorTabExtension ( const FName& InMajorTabId ) | Allows for registering a delegate callback for populating a FInsightsMajorTabExtender structure. |
void | RegisterComponent ( TSharedPtr< IInsightsComponent > Co... ) | Registers an IInsightsComponent. |
void | RegisterMajorTabConfig ( const FName& InMajorTabId, const FInsightsMajorTabConfig& InC... ) | Registers a major tab layout. |
void | ScheduleCommand ( const FString& InCmd ) | Called to schedule a command to run after session analysis is complete. |
void | SetUnrealInsightsLayoutIni ( const FString& InIniPath ) | Sets the ini path for saving persistent layout data. |
void | ShutdownUserInterface () | Called when the application shutsdown. |
void | StartAnalysisForLastLiveSession ( float InRetryTime ) | Starts analysis of the last live session. |
void | StartAnalysisForTrace ( uint32 InTraceId, bool InAutoQuit ) | Starts analysis of the specified trace. Called when the application starts in "Viewer" mode. |
void | StartAnalysisForTraceFile ( const TCHAR* InTraceFile, bool InAutoQuit ) | Starts analysis of the specified *.utrace file. |
void | UnregisterComponent ( TSharedPtr< IInsightsComponent > Co... ) | Unregisters an IInsightsComponent. |
void | UnregisterMajorTabConfig ( const FName& InMajorTabId ) | Unregisters a major tab layout. This will revert the major tab to spawning with its default layout |