1. Epic GamesDeveloper
  3. IUnrealInsightsModule

IUnrealInsightsModule

Interface for an Unreal Insights module.

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

Remarks

Interface for an Unreal Insights module.

Functions

  Type Name Description
Public function bool

ConnectToStore ( const TCHAR* InStoreHost,
uint32 InStorePort
)

 Connects to a specified store.
Public function void Creates the default trace store (for "Browser" mode).
Public function void Called when the application starts in "Browser" mode.
Public function void

CreateSessionViewer ( bool bAllowDebugTools
)

 Called when the application starts in "Viewer" mode.
Public function bool

Exec ( const TCHAR* Cmd,
FOutputDevice& Ar
)

 Execute command.
Public function Const const FInsightsMajorTabConfig &

FindMajorTabConfig ( const FName& InMajorTabId
)

 Finds a major tab config for the specified id.
Public function FOnRegisterMajorTabExtensions *

FindMajorTabLayoutExtension ( const FName& InMajorTabId
)

  
Public function Const TSharedPtr< const TraceServices::IAnalysisSession > Gets the current analysis session.
Public function UE::Trace::FStoreClient * Gets the store client.
Public function void

InitializeTesting ( bool InInitAutomationModules,
bool InAutoQuit
)

 Called to initialize testing in stand alone Insights.
Public function FOnInsightsMajorTabCreated & Callback invoked when a major tab is created
Public function FOnRegisterMajorTabExtensions &

OnRegisterMajorTabExtension ( const FName& InMajorTabId
)

 Allows for registering a delegate callback for populating a FInsightsMajorTabExtender structure.
Public function void Registers an IInsightsComponent.
Public function void

RegisterMajorTabConfig ( const FName& InMajorTabId,
const FInsightsMajorTabConfig& InConfig
)

 Registers a major tab layout.
Public function void

ScheduleCommand ( const FString& InCmd
)

 Called to schedule a command to run after session analysis is complete.
Public function void

SetUnrealInsightsLayoutIni ( const FString& InIniPath
)

 Sets the ini path for saving persistent layout data.
Public function void Called when the application shutsdown.
Public function void

StartAnalysisForLastLiveSession ( float InRetryTime
)

 Starts analysis of the last live session.
Public function void

StartAnalysisForTrace ( uint32 InTraceId,
bool InAutoQuit
)

 Starts analysis of the specified trace. Called when the application starts in "Viewer" mode.
Public function void

StartAnalysisForTraceFile ( const TCHAR* InTraceFile,
bool InAutoQuit
)

 Starts analysis of the specified *.utrace file.
Public function void Unregisters an IInsightsComponent.
Public function void

UnregisterMajorTabConfig ( const FName& InMajorTabId
)

 Unregisters a major tab layout. This will revert the major tab to spawning with its default layout

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page