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