My agentic slop goes here. Not intended for anyone else!
anil.recoil.org
1(** Kitty Graphics Protocol - Command *)
2
3type action =
4 [ `Transmit
5 | `Transmit_and_display
6 | `Query
7 | `Display
8 | `Delete
9 | `Frame
10 | `Animate
11 | `Compose ]
12
13type t
14(** A graphics protocol command. *)
15
16(** {2 Image Transmission} *)
17
18val transmit :
19 ?image_id:int ->
20 ?image_number:int ->
21 ?format:Kgp_types.format ->
22 ?transmission:Kgp_types.transmission ->
23 ?compression:Kgp_types.compression ->
24 ?width:int ->
25 ?height:int ->
26 ?size:int ->
27 ?offset:int ->
28 ?quiet:Kgp_types.quiet ->
29 unit ->
30 t
31(** Transmit image data without displaying. *)
32
33val transmit_and_display :
34 ?image_id:int ->
35 ?image_number:int ->
36 ?format:Kgp_types.format ->
37 ?transmission:Kgp_types.transmission ->
38 ?compression:Kgp_types.compression ->
39 ?width:int ->
40 ?height:int ->
41 ?size:int ->
42 ?offset:int ->
43 ?quiet:Kgp_types.quiet ->
44 ?placement:Kgp_placement.t ->
45 unit ->
46 t
47(** Transmit image data and display it immediately. *)
48
49val query :
50 ?format:Kgp_types.format ->
51 ?transmission:Kgp_types.transmission ->
52 ?width:int ->
53 ?height:int ->
54 ?quiet:Kgp_types.quiet ->
55 unit ->
56 t
57(** Query terminal support without storing the image. *)
58
59(** {2 Display} *)
60
61val display :
62 ?image_id:int ->
63 ?image_number:int ->
64 ?placement:Kgp_placement.t ->
65 ?quiet:Kgp_types.quiet ->
66 unit ->
67 t
68(** Display a previously transmitted image. *)
69
70(** {2 Deletion} *)
71
72val delete : ?quiet:Kgp_types.quiet -> Kgp_types.delete -> t
73(** Delete images or placements. *)
74
75(** {2 Animation} *)
76
77val frame :
78 ?image_id:int ->
79 ?image_number:int ->
80 ?format:Kgp_types.format ->
81 ?transmission:Kgp_types.transmission ->
82 ?compression:Kgp_types.compression ->
83 ?width:int ->
84 ?height:int ->
85 ?quiet:Kgp_types.quiet ->
86 frame:Kgp_frame.t ->
87 unit ->
88 t
89(** Transmit animation frame data. *)
90
91val animate :
92 ?image_id:int ->
93 ?image_number:int ->
94 ?quiet:Kgp_types.quiet ->
95 Kgp_animation.t ->
96 t
97(** Control animation playback. *)
98
99val compose :
100 ?image_id:int ->
101 ?image_number:int ->
102 ?quiet:Kgp_types.quiet ->
103 Kgp_compose.t ->
104 t
105(** Compose animation frames. *)
106
107(** {2 Output} *)
108
109val write : Buffer.t -> t -> data:string -> unit
110(** Write the command to a buffer. *)
111
112val to_string : t -> data:string -> string
113(** Convert command to a string. *)