Skip to content

Hex1b.Surfaces

Assembly: Hex1b.dll

Classes

CellEffects

Provides factory methods for common computed cell effects.

csharp
public static class CellEffects

CompositeSurface

A surface composed of multiple layered surface sources with deferred resolution.

csharp
public sealed class CompositeSurface : ISurfaceSource

KgpVisibility

Tracks visibility of a KGP image placement after occlusion by other content.

csharp
public sealed class KgpVisibility

SixelEncoder

Encodes pixel data to Sixel graphics format.

csharp
public static class SixelEncoder

SixelFragment

Represents a fragment of a sixel image after clipping or occlusion.

csharp
public sealed class SixelFragment

SixelPixelBuffer

Represents a decoded sixel image as RGBA pixels.

csharp
public sealed class SixelPixelBuffer

SixelVisibility

Tracks visibility information for a sixel during compositing.

csharp
public sealed class SixelVisibility

Surface

A 2D grid of cells representing a rectangular area of terminal content.

csharp
public sealed class Surface : ISurfaceSource

SurfaceCells

Provides commonly used values.

csharp
public static class SurfaceCells

SurfaceComparer

Provides methods for comparing surfaces and generating output.

csharp
public static class SurfaceComparer

SurfaceDiff

Represents the difference between two surface states.

csharp
public sealed class SurfaceDiff

SurfaceRenderContext

A render context that writes to a instead of emitting ANSI strings.

csharp
public class SurfaceRenderContext : Hex1bRenderContext

Structs

CellMetrics

Represents the pixel dimensions of a terminal cell.

csharp
public readonly record struct CellMetrics : IEquatable<CellMetrics>

ChangedCell

Represents a cell that has changed between two surface states.

csharp
public readonly record struct ChangedCell : IEquatable<ChangedCell>

ComputeContext

Provides context for computing a cell value during layer resolution.

csharp
public readonly ref struct ComputeContext

KgpCellAccess

Provides read-only access to KGP image metadata at a specific cell position.

csharp
public readonly struct KgpCellAccess

PixelRect

Represents a rectangle in pixel coordinates.

csharp
public readonly record struct PixelRect : IEquatable<PixelRect>

Rgba32

Represents an RGBA pixel color.

csharp
public readonly record struct Rgba32 : IEquatable<Rgba32>

SixelPixelAccess

Provides read-only access to sixel pixel data at a specific cell position.

csharp
public readonly struct SixelPixelAccess

SurfaceCell

Represents a single cell in a surface - the atomic unit of terminal rendering.

csharp
public readonly record struct SurfaceCell : IEquatable<SurfaceCell>

Interfaces

ISurfaceSource

Common interface for any source that can provide terminal cells.

csharp
public interface ISurfaceSource

Delegates

CellCompute

Delegate for computing a cell value dynamically.

Parameters:

  • context (ComputeContext): The context providing position and cell access.

Returns: SurfaceCell

The computed cell value.

csharp
public delegate SurfaceCell CellCompute(ComputeContext context)

Released under the MIT License.