Skip to main content

Margin struct

Namespace: Arlecchino.Rendering · Assembly: Arlecchino.Core

Blank space around something, measured in cells. Used both by the flow calls on Surface and by SurfaceRegion.Inset.

public readonly struct Margin : IEquatable<Margin>

Implements IEquatable<T><Margin>

Constructors

MemberSummary
Margin(int)The same amount of space on all four sides.
Margin(int, int, int, int)Blank space around something, measured in cells. Used both by the flow calls on Surface and by SurfaceRegion.Inset.

Properties

MemberSummary
BottomRows kept free below.
LeftCells kept free on the left.
RightCells kept free on the right.
TopRows kept free above.

Methods

MemberSummary
Deconstruct(out int, out int, out int, out int)

Constructors in detail

Margin(int)

public Margin(int size);

The same amount of space on all four sides.

Parameters

NameTypeDescription
sizeintCells kept free on every side.

Margin(int, int, int, int)

public Margin(int Left, int Top, int Right, int Bottom);

Blank space around something, measured in cells. Used both by the flow calls on Surface and by SurfaceRegion.Inset.

Parameters

NameTypeDescription
LeftintCells kept free on the left.
TopintRows kept free above.
RightintCells kept free on the right.
BottomintRows kept free below.

Properties in detail

Bottom

public int Bottom { get; init; }

Rows kept free below.

Type int

Left

public int Left { get; init; }

Cells kept free on the left.

Type int

public int Right { get; init; }

Cells kept free on the right.

Type int

Top

public int Top { get; init; }

Rows kept free above.

Type int

Methods in detail

Deconstruct(out int, out int, out int, out int)

public void Deconstruct(out int Left, out int Top, out int Right, out int Bottom);

Parameters

NameTypeDescription
Leftint
Topint
Rightint
Bottomint