Skip to content
ghostty-webgpu
Search
Ctrl
K
Cancel
Source on GitHub
Select theme
Dark
Light
Auto
Menu
Start here
Introduction
First terminal
A real shell
Coming from xterm.js
Coming from ghostty-web
Guides
Connect to a PTY
Renderers and fallbacks
Run in a worker
Load fonts and fit the grid
Themes and Ghostty config
Terminal hotkeys
Scrollback and reading history
Examples
Echo terminal
Reference
Options
Main API
Classes
DomTerminalRenderer
GhosttyError
GhosttyRenderState
GhosttyRuntime
GhosttyTerminal
Terminal
TerminalSession
WebGpuTerminalRenderer
Interfaces
CellStyle
ClipboardRepresentation
ClipboardWrite
CursorState
DamageSnapshot
DecodedPng
DeviceAttributes
DomClipboardWriteDecision
Extension
ExtensionHandle
ExtensionScope
GhosttyWebGpuFrameHandler
GhosttyWebGpuRenderer
GhosttyWebGpuTerminalAppearanceApi
GhosttyWebGpuTerminalDiagnostics
GhosttyWebGpuTerminalEventMap
GhosttyWebGpuTerminalOptions
GhosttyWebGpuTerminalResizeEvent
LinkCell
LinkLineSnapshot
LinkProvider
LinkProviderRegistration
LinkRange
LinkResolution
LinkResolverError
LinkResolverOptions
ProvidedLink
ReadLinesOptions
ReadRowsOptions
ReadTextRowsOptions
RenderCell
RenderCursorSnapshot
RenderCursorViewport
RendererFrameRow
RendererFrameSnapshot
RendererGridSize
RendererMetrics
RendererTextFrameRow
RendererTextFrameSnapshot
RendererTheme
RenderFrameHtmlOptions
RenderRow
RenderStateSource
RenderTextRow
RgbColor
RuntimeOptions
SelectionCoordinates
SelectionDragEvent
SelectionGestureGeometry
SelectionGestureRelease
SelectionGestureUpdate
SelectionPoint
SelectionPressEvent
SelectionSurfacePosition
TerminalApi
TerminalAppearance
TerminalAppearanceEvent
TerminalAppearanceOptions
TerminalClipboard
TerminalClipboardRepresentation
TerminalClipboardWrite
TerminalColors
TerminalCursor
TerminalCursorSettings
TerminalDataEvent
TerminalEffects
TerminalElementPadding
TerminalErrorEvent
TerminalFitEnvironment
TerminalFitGrid
TerminalFitResizeObserver
TerminalFitResult
TerminalFittedFont
TerminalFontMeasurement
TerminalFontSettings
TerminalGeometry
TerminalGrid
TerminalHotkeyConnection
TerminalInputConnection
TerminalInputModes
TerminalKeyInput
TerminalLine
TerminalMeasuredText
TerminalModifiers
TerminalMouseEvent
TerminalMouseGeometry
TerminalMouseInput
TerminalMouseState
TerminalMutationResult
TerminalOptions
TerminalPoint
TerminalPrintingUnit
TerminalRenderRequestEvent
TerminalResizeEvent
TerminalScrollbar
TerminalScrollbarClock
TerminalScrollEvent
TerminalSelectionEvent
TerminalSelectionFormatOptions
TerminalSessionEventMap
TerminalSessionOptions
TerminalSessionSubscription
TerminalSize
TerminalSubmittedFrame
TerminalSubmittedRow
TerminalSubmittedText
TerminalTextMeasurement
TerminalTitleEvent
TerminalViewportOptions
TerminalViewportPaint
WebGpuTerminalRendererOptions
Type Aliases
Contributions
CursorStyle
DomClipboardWritePolicy
ExtensionInput
ExtensionValue
GhosttyWebGpuRendererFactory
GhosttyWebGpuTerminalAccessibilityOptions
GhosttyWebGpuTerminalCopy
GhosttyWebGpuTerminalEventType
GhosttyWebGpuTerminalLifecycle
GhosttyWebGpuTerminalListener
GhosttyWebGpuTerminalScrollbarOptions
GhosttyWebGpuTerminalSubscription
GhosttyWebGpuThemeProjection
LinkActivation
LinkHit
RendererFrameCell
SelectionAutoscrollDirection
TerminalBellEvent
TerminalClipboardLocation
TerminalClipboardWritePolicy
TerminalClipboardWriteResult
TerminalColor
TerminalColorScheme
TerminalCommandId
TerminalCursorSnapshot
TerminalCursorStyle
TerminalElementPaddingInput
TerminalFitFont
TerminalGeneratedInput
TerminalHotkeyOwnership
TerminalHotkeysOptions
TerminalInputData
TerminalInputEvent
TerminalInputHandler
TerminalInputResult
TerminalKeyAction
TerminalLinkRequest
TerminalModifierSide
TerminalMouseAction
TerminalMouseButton
TerminalPointerOwner
TerminalPointTag
TerminalRendererTheme
TerminalResult
TerminalSelectionDragInput
TerminalSelectionPressInput
TerminalSelectionReleaseInput
TerminalSessionEventType
TerminalSessionListener
TerminalSessionRuntime
TerminalTheme
WasmSource
Variables
GHOSTTY_SOURCE_REPOSITORY
GHOSTTY_SOURCE_REVISION
TERMINAL_READ_LINES_MAX_ROWS
TERMINAL_VIEWPORT_MAX_BYTES
terminalDefaultPack
terminalShellKeysPack
Functions
attachTerminalHotkeys
calculateTerminalFittedFont
fitTerminalFont
paintTerminalViewport
renderFrameToHtml
snapshotRenderState
Worker API
Classes
TerminalWorkerError
Interfaces
TerminalApi
TerminalOutputAck
TerminalOutputMessage
TerminalOutputReady
TerminalSubmittedFrame
TerminalSubmittedRow
TerminalSubmittedText
WorkerAssets
WorkerFontFace
WorkerTerminalOptions
Type Aliases
Terminal
TerminalResult
WorkerBackend
Variables
Terminal
Config resolver API
Interfaces
GhosttyConfigAppearance
GhosttyConfigProfile
GhosttyConfigRgb
GhosttyConfigSurface
GhosttyConfigTheme
Type Aliases
GhosttyConfigDegradedFeature
GhosttyConfigResolveResult
GhosttyConfigUnavailableReason
Functions
resolveGhosttyConfigAppearance
Concepts
Benchmarks
Damage tracking
The wasm core
Source on GitHub
Select theme
Dark
Light
Auto
GhosttyWebGpuTerminalSubscription
GhosttyWebGpuTerminalSubscription
=
EventSubscription