mirrors/ghostty
1
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2026-08-25 00:21:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

ghostty.h: mark as internal

Browse Source 
Its moniker has been `libghostty-internal` for *quite* a while now among
maintainers but that has never really been clarified for the public aside
from a couple comments on discussions. Judging by how many people still
try to vibe their way into making this work for their purposes, I think
we should clear this up once and for all.
This commit is contained in:
Leah Amelia Chen
2026-08-09 20:19:53 +08:00
parent 05221c11c9
commit d6248a32dd
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
include/ghostty.h
View File

@@ -1,10 +1,14 @@
// Ghostty embedding API. The documentation for the embedding API is
// only within the Zig source files that define the implementations. This
// isn't meant to be a general purpose embedding API (yet) so there hasn't
// been documentation or example work beyond that.
// Ghostty's internal embedder API, a.k.a. "libghostty-internal".
//
// The only consumer of this API is the macOS app, but the API is built to
// be more general purpose.
// The only consumer of this API is the macOS app, and while it is fairly
// comprehensive, it is tailored to the needs of the macOS app and not designed
// for external use, hence why most functions are undocumented and some are
// macOS-specific (e.g. ones dealing with the Metal graphics API).
//
// External embedders should instead use `libghostty-vt` or other related
// packages, which are extensively documented and designed from the ground up
// to be used in other software. Header files for which can be found in
// `include/ghostty/`.
#ifndef GHOSTTY_H
#define GHOSTTY_H