Debugging Tools

instant3Dhub: Debugging Tools

instant3Dhub

Detailed Description

Tools for debugging instant3Dhub related issues.

Functions
bool	AI3DHConnector::RequestRemoteCullerDebugStream ()

UTexture2D *	AI3DHConnector::GetRemoteCullerDebugStreamTexture ()

const TArray< FI3DHDebugMetric > &	AI3DHConnector::GetDebugMetrics ()

Function Documentation

◆ GetDebugMetrics()

const TArray< FI3DHDebugMetric > & AI3DHConnector::GetDebugMetrics ( )

Returns a list of metrics describing the internal state of the connector.

Metrics are meant for manual debugging and visualizing the internal system state. Applications should display the metrics in an interactive table (i.e. updated every frame). Applications should not depend on specific metrics being available or use metrics for normal operations.

Returns: Array of metrics. The data is valid until the next call to this function.

◆ GetRemoteCullerDebugStreamTexture()

UTexture2D * AI3DHConnector::GetRemoteCullerDebugStreamTexture ( )

Returns a texture containing the current remote culler debug image.

You must call AI3DHConnector::RequestRemoteCullerDebugStream() once first to enable the debug stream. Afterwards, this function might still return nullptr for a while, while the stream is established.

If possible, the returned texture object is reused / updated, when a new image is received. We recommend calling this function every frame and updating your state, when the return value changes.

Returns: Texture object or nullptr.

◆ RequestRemoteCullerDebugStream()

bool AI3DHConnector::RequestRemoteCullerDebugStream ( )

Establishes a connection to the remote culler service and continuously streams debug images from the service.

The resulting image can be queried using AI3DHConnector::GetRemoteCullerDebugStreamTexture().

Requires that the connector is connected (AI3DHConnector::IsConnectedToHub()).

The stream stays open until the connector is disconnected.

Returns: True if the debug stream is available, false if not.