Table of Contents

Interface IInstrumentsSink

Namespace
Xui.Core.Debug
Assembly
Xui.Core.dll

Per-run-loop instrumentation sink that receives fully-formatted messages. Thread-aligned — must not be shared across run loops or threads.

public interface IInstrumentsSink : IViewInstrumentsSink, IDisposable
Inherited Members

Methods

BeginTrace(IRenderSurfaceInstrumentsSink, Scope, LevelOfDetail, ReadOnlySpan<char>)

Begins a named trace scope. Must be paired with EndTrace().

void BeginTrace(IRenderSurfaceInstrumentsSink surface, Scope scope, LevelOfDetail lod, ReadOnlySpan<char> message)

Parameters

surface IRenderSurfaceInstrumentsSink
scope Scope
lod LevelOfDetail
message ReadOnlySpan<char>

CreateRenderSurface(string)

Creates a dedicated sink for one window, popup, or other render surface.

IRenderSurfaceInstrumentsSink CreateRenderSurface(string name)

Parameters

name string

Returns

IRenderSurfaceInstrumentsSink

EndTrace(IRenderSurfaceInstrumentsSink)

Ends the most recently opened trace scope.

void EndTrace(IRenderSurfaceInstrumentsSink surface)

Parameters

surface IRenderSurfaceInstrumentsSink

IsEnabled(IRenderSurfaceInstrumentsSink, Scope, LevelOfDetail)

Writes a surface event while retaining its source identity for aggregation.

bool IsEnabled(IRenderSurfaceInstrumentsSink surface, Scope scope, LevelOfDetail lod)

Parameters

surface IRenderSurfaceInstrumentsSink
scope Scope
lod LevelOfDetail

Returns

bool

Log(IRenderSurfaceInstrumentsSink, Scope, LevelOfDetail, ReadOnlySpan<char>)

Writes a single log message to the sink.

void Log(IRenderSurfaceInstrumentsSink surface, Scope scope, LevelOfDetail lod, ReadOnlySpan<char> message)

Parameters

surface IRenderSurfaceInstrumentsSink
scope Scope
lod LevelOfDetail
message ReadOnlySpan<char>

TrackTextMeasure(IRenderSurfaceInstrumentsSink, long)

Reports one text measurement and the elapsed underlying-context ticks.

void TrackTextMeasure(IRenderSurfaceInstrumentsSink surface, long elapsedTicks)

Parameters

surface IRenderSurfaceInstrumentsSink
elapsedTicks long

TrackView(IRenderSurfaceInstrumentsSink, Scope, View)

Reports structured traversal of a view in the specified scope.

void TrackView(IRenderSurfaceInstrumentsSink surface, Scope scope, View view)

Parameters

surface IRenderSurfaceInstrumentsSink
scope Scope
view View