mirror-ghostty/example/c-vt-mouse-encode
Mitchell Hashimoto 15b8976d64
docs: extract inline code examples into standalone projects
Extract inline @code blocks from vt headers (size_report.h, modes.h,
sgr.h, paste.h, mouse.h, key.h) into standalone buildable examples
under example/. Each header now uses Doxygen @snippet tags to include
code from the example source files, keeping documentation in sync
with code that is verified to compile and run.

New example projects: c-vt-size-report and c-vt-modes. Existing
examples (c-vt-sgr, c-vt-paste, c-vt-mouse-encode, c-vt-key-encode)
gain snippet markers so their code can be referenced from the headers.
Conceptual snippets in key.h, mouse.h, and key/encoder.h that show
terminal-state usage patterns remain inline since they cannot be
compiled standalone.
2026-03-17 17:03:58 -07:00
..
src docs: extract inline code examples into standalone projects 2026-03-17 17:03:58 -07:00
README.md example: add C mouse encoding example 2026-03-15 20:14:07 -07:00
build.zig example: add C mouse encoding example 2026-03-15 20:14:07 -07:00
build.zig.zon example: add C mouse encoding example 2026-03-15 20:14:07 -07:00

README.md

Example: ghostty-vt C Mouse Encoding

This example demonstrates how to use the ghostty-vt C library to encode mouse events into terminal escape sequences.

This example specifically shows how to:

  1. Create a mouse encoder with the C API
  2. Configure tracking mode and output format (this example uses SGR)
  3. Set terminal geometry for pixel-to-cell coordinate mapping
  4. Create and configure a mouse event
  5. Encode the mouse event into a terminal escape sequence

The example encodes a left button press at pixel position (50, 40) using SGR format, producing an escape sequence like \x1b[<0;6;3M.

Usage

Run the program:

zig build run