Interface IRenderEncoderMetrics

Namespace

BSGameLib.Game.Rendering

Assembly

BSGameLib.Game.dll

Counts what the encoders submit, in total and for each pass. Reset() clears the counts.

public interface IRenderEncoderMetrics

Properties

BackendFlushes

The times a batch was flushed to the backend since the last Reset().

int BackendFlushes { get; }

Property Value

int

PassMetrics

The counts for each pass, by name. Empty when nothing has been submitted.

IReadOnlyList<RenderEncoderPassMetrics> PassMetrics { get; }

Property Value

IReadOnlyList<RenderEncoderPassMetrics>

ResourceAllocatorStats

The transient render target statistics last recorded with UpdateResourceAllocatorStats(FrameGraphResourceAllocatorStats).

FrameGraphResourceAllocatorStats ResourceAllocatorStats { get; }

Property Value

FrameGraphResourceAllocatorStats

SubmittedCallbacks

The draw callbacks submitted with SubmitDrawCall(Action) since the last Reset().

int SubmittedCallbacks { get; }

Property Value

int

SubmittedShapes

The shapes submitted since the last Reset().

int SubmittedShapes { get; }

Property Value

int

SubmittedSprites

The sprites submitted since the last Reset().

int SubmittedSprites { get; }

Property Value

int

Methods

IncrementBackendFlush(RenderPassTag, string)

Counts one flush of a batch to the backend, for the pass called passName.

void IncrementBackendFlush(RenderPassTag passTag, string passName)

Parameters

passTag RenderPassTag

passName string

IncrementCallbacks(RenderPassTag, string, int)

Adds amount to the callback count of the pass called passName, which is counted as "Pass" when the name is blank.

void IncrementCallbacks(RenderPassTag passTag, string passName, int amount = 1)

Parameters

passTag RenderPassTag

passName string

amount int

IncrementShapes(RenderPassTag, string, int)

Adds amount to the shape count of the pass called passName, which is counted as "Pass" when the name is blank.

void IncrementShapes(RenderPassTag passTag, string passName, int amount = 1)

Parameters

passTag RenderPassTag

passName string

amount int

IncrementSprites(RenderPassTag, string, int)

Adds amount to the sprite count of the pass called passName, which is counted as "Pass" when the name is blank.

void IncrementSprites(RenderPassTag passTag, string passName, int amount = 1)

Parameters

passTag RenderPassTag

passName string

amount int

Reset()

Clears every count, the per-pass counts and the allocator statistics.

void Reset()

UpdateResourceAllocatorStats(FrameGraphResourceAllocatorStats)

Records stats as the current transient render target statistics.

void UpdateResourceAllocatorStats(FrameGraphResourceAllocatorStats stats)

Parameters

stats FrameGraphResourceAllocatorStats