ScreenLabelPlacementEntry

Description

struct Tinman.Engine.Drawing.ScreenLabelPlacementEntry

Represents an entry for a IScreenLabel in a ScreenLabelPlacement object.

public static readonly attribute None → (ScreenLabelPlacementEntry)

Represents an empty placement entry.

public readonly attribute Bounds → (Box2I)

The screen bounds that have been passed to ScreenLabelPlacement.Add.

During rendering, Bounds will be passed to IScreenLabel.RenderScreenLabel.

public readonly attribute Depth → (float32)

The depth value that has been passed to ScreenLabelPlacement.Add.

During rendering, Depth will be passed to Graphics.PushDepth.

public readonly attribute Group → (string)

The display group of this screen label or null for none.

In each view, only one screen label of each group can be visible. Screen labels with different priorities are put into different groups.

public readonly attribute Label → (IScreenLabel)

The screen label that has been passed to ScreenLabelPlacement.Add.

public readonly attribute Offset → (Vec2F)

The sub-pixel offset that has been passed to ScreenLabelPlacement.Add.

During rendering, Offset will be passed to Graphics.Offset.

public readonly attribute Priority → (int32)

The priority that has been passed to ScreenLabelPlacement.Add.