Class DebugOverlayFrame

Namespace

TileWorld.Engine.Render

Assembly

TileWorld.Engine.dll

Captures the output of a debug overlay build pass.

public sealed class DebugOverlayFrame

Inheritance

object

DebugOverlayFrame

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DebugOverlayFrame(WorldTileCoord?, ChunkCoord?, Int2?, IReadOnlyList<string>, IReadOnlyList<SpriteDrawCommand>)

Creates a debug overlay frame.

public DebugOverlayFrame(WorldTileCoord? hoveredTileCoord, ChunkCoord? hoveredChunkCoord, Int2? hoveredLocalCoord, IReadOnlyList<string> panelLines, IReadOnlyList<SpriteDrawCommand> drawCommands)

Parameters

hoveredTileCoord WorldTileCoord?

The hovered tile coordinate when the cursor is inside the viewport.

hoveredChunkCoord ChunkCoord?

The chunk coordinate containing the hovered tile.

hoveredLocalCoord Int2?

The hovered tile coordinate in local chunk space.

panelLines IReadOnlyList<string>

The textual lines shown in the debug panel.

drawCommands IReadOnlyList<SpriteDrawCommand>

The draw commands generated for the overlay.

Properties

DrawCommands

Gets the overlay draw commands generated for the current frame.

public IReadOnlyList<SpriteDrawCommand> DrawCommands { get; }

Property Value

IReadOnlyList<SpriteDrawCommand>

HoveredChunkCoord

Gets the chunk coordinate containing the hovered tile.

public ChunkCoord? HoveredChunkCoord { get; }

Property Value

ChunkCoord?

HoveredLocalCoord

Gets the hovered tile coordinate in local chunk space.

public Int2? HoveredLocalCoord { get; }

Property Value

Int2?

HoveredTileCoord

Gets the hovered world-tile coordinate when the cursor is inside the viewport.

public WorldTileCoord? HoveredTileCoord { get; }

Property Value

WorldTileCoord?

PanelLines

Gets the textual lines displayed by the debug panel.

public IReadOnlyList<string> PanelLines { get; }

Property Value

IReadOnlyList<string>