API Reference

RoyalTerminal ships a large managed surface area across UI, terminal, transport, VT, rendering, and Ghostty integration packages. This section keeps the article-led docs intact and adds generated reference pages for the public managed APIs that ship from src/.

Use the guide articles for workflows and architecture. Use this reference when you need exact type and member contracts.

Coverage

• Managed packages covered: 29
• Source links in generated pages point back to the repository paths on GitHub.
• Native-only runtime asset packages are excluded because they do not expose managed public APIs.

Package Groups

UI And Host

Package	Description	Related guide
RoyalApps.RoyalTerminal.Avalonia	Backend-neutral Avalonia terminal controls and presentation infrastructure with SkiaSharp rendering and virtualized scrolling.	Embedding In Avalonia
RoyalApps.RoyalTerminal.Avalonia.Settings	Settings panel controls and state for RoyalTerminal Avalonia integration.	Sessions, Profiles, And Settings
RoyalApps.RoyalTerminal.Avalonia.Rendering.GhosttyInterop	Avalonia-specific render target acquisition and draw-loop adapters for Ghostty renderer interop.	Rendering, Text, And Graphics

Core And Services

Package	Description	Related guide
RoyalApps.RoyalTerminal.Terminal	Core terminal contracts and screen model.	Terminal Engine And Screen State
RoyalApps.RoyalTerminal.Terminal.Services.Contracts	Contracts for terminal session lifecycle services.	Architecture
RoyalApps.RoyalTerminal.Terminal.Services	Implementations for terminal session lifecycle services.	Sessions, Profiles, And Settings
RoyalApps.RoyalTerminal.Unicode	Deterministic Unicode data and terminal width helpers for RoyalTerminal.GhosttySharp.	Terminal Engine And Screen State
RoyalApps.RoyalTerminal.Sixel	Reusable managed sixel decoder for RoyalTerminal.	Terminal Engine And Screen State

VT And Terminal Engine

Package	Description	Related guide
RoyalApps.RoyalTerminal.Terminal.Vt.Default	Default VT processor factory with managed fallback and optional native provider support.	Terminal Engine And Screen State
RoyalApps.RoyalTerminal.Terminal.Vt.Managed	Managed VT processor implementation for RoyalTerminal terminal contracts.	Terminal Engine And Screen State
RoyalApps.RoyalTerminal.Terminal.Vt.Ghostty	Native Ghostty-backed VT processor implementation for RoyalTerminal terminal contracts.	Ghostty Integration
RoyalApps.RoyalTerminal.GhosttySharp	High-performance .NET 10 bindings for the official Ghostty VT C API. Provides zero-alloc P/Invoke via LibraryImport, span-friendly terminal access, and managed wrappers over libghostty-vt.	Ghostty Integration

PTY And Transports

Package	Description	Related guide
RoyalApps.RoyalTerminal.Terminal.Pty.Platform	Platform-selecting PTY factory over Unix/Windows implementations.	Transports And Remote Access
RoyalApps.RoyalTerminal.Terminal.Pty.Unix	Unix PTY implementation for RoyalTerminal terminal contracts.	Transports And Remote Access
RoyalApps.RoyalTerminal.Terminal.Pty.Windows	Windows ConPTY implementation for RoyalTerminal terminal contracts.	Transports And Remote Access
RoyalApps.RoyalTerminal.Terminal.Transport.Pty	PTY terminal transport provider over platform PTY implementations.	Transports And Remote Access
RoyalApps.RoyalTerminal.Terminal.Transport.Pipe	Process pipe terminal transport provider.	Transports And Remote Access
RoyalApps.RoyalTerminal.Terminal.Transport.Raw	Raw TCP terminal transport provider.	Transports And Remote Access
RoyalApps.RoyalTerminal.Terminal.Transport.Telnet	Telnet terminal transport provider.	Transports And Remote Access
RoyalApps.RoyalTerminal.Terminal.Transport.Serial	Serial line terminal transport provider.	Transports And Remote Access
RoyalApps.RoyalTerminal.Terminal.Transport.Ssh.Abstractions	SSH transport abstractions for terminal backends.	Transports And Remote Access
RoyalApps.RoyalTerminal.Terminal.Transport.Ssh.SshNet	SSH terminal transport provider implemented with SSH.NET.	Transports And Remote Access
RoyalApps.RoyalTerminal.Terminal.Transport.Ssh.SshNet.Agent	Optional SSH.NET agent authentication adapter for terminal SSH transport.	Transports And Remote Access

Rendering And Native Interop

Package	Description	Related guide
RoyalApps.RoyalTerminal.Rendering.Contracts	Backend-agnostic contracts for GPU terminal rendering integration.	Rendering, Text, And Graphics
RoyalApps.RoyalTerminal.Rendering.Text	RoyalApps.RoyalTerminal.Rendering.Text managed API surface.	Rendering, Text, And Graphics
RoyalApps.RoyalTerminal.Shaders	Dependency-free shader source models and compatibility translation for Skia Runtime Effect terminal shaders.	Shader Support
RoyalApps.RoyalTerminal.Rendering.Skia	SkiaSharp terminal rendering core independent of Avalonia controls.	Rendering, Text, And Graphics
RoyalApps.RoyalTerminal.Rendering.Interop.Ghostty	Managed interop wrappers for ghostty-renderer-capi with safe handles and result mapping.	Ghostty Integration
RoyalApps.RoyalTerminal.Rendering.Interop.Ghostty.Skia	SkiaSharp bridge for Ghostty renderer interop with texture and CPU fallback paths.	Ghostty Integration

Native Asset Packages

• RoyalTerminal.GhosttySharp.Native.OSX
• RoyalTerminal.GhosttySharp.Native.Win64
• RoyalTerminal.GhosttySharp.Native.Linux64

Native asset packages remain documented in the package guide because they ship runtime binaries and MSBuild targets rather than managed public APIs.

Reference Notes

• RoyalTerminal.GhosttySharp is always source-indexed because the current Markdown reflection generator cannot expand its public function-pointer signatures.
• Other packages may temporarily fall back to source-indexed reference pages when the reflection generator cannot load the built assembly in the current environment.