summaryrefslogtreecommitdiff
path: root/src/kinds/pardes_addon.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/kinds/pardes_addon.h')
-rw-r--r--src/kinds/pardes_addon.h12
1 files changed, 7 insertions, 5 deletions
diff --git a/src/kinds/pardes_addon.h b/src/kinds/pardes_addon.h
index 072f2447..0870aa6f 100644
--- a/src/kinds/pardes_addon.h
+++ b/src/kinds/pardes_addon.h
@@ -20,8 +20,9 @@
* pa_paint and pa_ops: a core reads an addon's new ones by its head's
* minor, an addon pardes's by api->size.
*
- * addons/fake/fake.c implements every function; it is the template, and
- * addons/snake/snake.c a game in it.
+ * addons/fake/fake.c implements every function; it is the template. In
+ * Zig, src/kinds/addon.zig makes the pa_ops from a struct, and
+ * addons/snake/snake.zig is a game in it.
*/
#ifndef PARDES_ADDON_H
#define PARDES_ADDON_H
@@ -305,9 +306,10 @@ typedef struct pa_ops {
uint32_t (*job_run)(const uint8_t *in, uint32_t n, pa_out *out);
/* Back on pardes's thread; `out` is gone after the call. */
void (*job_done)(void *st, uint32_t token, const uint8_t *out, uint32_t n);
- /* The pane's record for a dump: at most `n` bytes, n at least 1 MiB; 0 is
- * no record (load is not called and the pane reopens from its path, its
- * `where` and its words' last values), and so is having no dump. */
+ /* The pane's record for a dump: its length, written in `n` bytes (n at
+ * least 1 MiB), or a length past n, unwritten, to be called again with that
+ * many; 0 is no record (load is not called and the pane reopens from its
+ * path, its `where` and its words' last values), and so is having no dump. */
uint32_t (*dump)(void *st, uint8_t *buf, uint32_t n);
/* On the state open(path, bytes, len) returned, with the writer's
* head.version: PA_OK, or nonzero to refuse (the pane waits as a