Skip to content

KgpPlacementRenderGeometry

Namespace: Hex1b

Assembly: Hex1b.dll

Describes exact image and clip bounds for a KGP placement in terminal-cell units relative to the placement's row and column.

csharp
public readonly record struct KgpPlacementRenderGeometry : IEquatable<KgpPlacementRenderGeometry>

Implements

Constructors

KgpPlacementRenderGeometry(double, double, double, double, double, double, double, double)

Describes exact image and clip bounds for a KGP placement in terminal-cell units relative to the placement's row and column.

Parameters:

  • ClipOffsetXInCells (Double): Horizontal clip offset from the placement column.
  • ClipOffsetYInCells (Double): Vertical clip offset from the placement row.
  • ClipWidthInCells (Double): Width of the visible clip rectangle.
  • ClipHeightInCells (Double): Height of the visible clip rectangle.
  • ImageOffsetXInCells (Double): Horizontal offset of the complete scaled image.
  • ImageOffsetYInCells (Double): Vertical offset of the complete scaled image.
  • ImageWidthInCells (Double): Width of the complete scaled image.
  • ImageHeightInCells (Double): Height of the complete scaled image.
csharp
public KgpPlacementRenderGeometry(double ClipOffsetXInCells, double ClipOffsetYInCells, double ClipWidthInCells, double ClipHeightInCells, double ImageOffsetXInCells, double ImageOffsetYInCells, double ImageWidthInCells, double ImageHeightInCells)

Properties

ClipHeightInCells

Height of the visible clip rectangle.

Returns: Double

csharp
public double ClipHeightInCells { get; init; }

ClipOffsetXInCells

Horizontal clip offset from the placement column.

Returns: Double

csharp
public double ClipOffsetXInCells { get; init; }

ClipOffsetYInCells

Vertical clip offset from the placement row.

Returns: Double

csharp
public double ClipOffsetYInCells { get; init; }

ClipWidthInCells

Width of the visible clip rectangle.

Returns: Double

csharp
public double ClipWidthInCells { get; init; }

ImageHeightInCells

Height of the complete scaled image.

Returns: Double

csharp
public double ImageHeightInCells { get; init; }

ImageOffsetXInCells

Horizontal offset of the complete scaled image.

Returns: Double

csharp
public double ImageOffsetXInCells { get; init; }

ImageOffsetYInCells

Vertical offset of the complete scaled image.

Returns: Double

csharp
public double ImageOffsetYInCells { get; init; }

ImageWidthInCells

Width of the complete scaled image.

Returns: Double

csharp
public double ImageWidthInCells { get; init; }

Remarks

Unicode-placeholder fragments can begin or end partway through a cell after aspect-ratio fitting. Ordinary KGP placements do not require this metadata.

Released under the MIT License.