summaryrefslogtreecommitdiff
path: root/docs/guide.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guide.md')
-rw-r--r--docs/guide.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/guide.md b/docs/guide.md
index f195e5e..a65972f 100644
--- a/docs/guide.md
+++ b/docs/guide.md
@@ -40,8 +40,11 @@ it advertises CSD. Check each result and provide an application fallback.
## Window creation and callbacks
All examples include `<yasl/app.h>` and call `yasl_run()` with a
-`yasl_app_desc`. Create surfaces in `init`, handle `YASL_EVENT_*` notifications
-in `event`, and render into `frame->cpu.pixels` in `frame`. Present with
+`yasl_app_desc`. Set `window` to a `yasl_window_spec` for a single toplevel,
+which the runner creates before `init` with its first frame requested; `yasl_run()` returns an
+error if creation fails. Create further surfaces in the optional `init`, handle
+`YASL_EVENT_*` notifications in `event`, and render into `frame->cpu.pixels` in
+`frame`. Present with
`yasl_frame_present_cpu(frame, NULL, 0)` and return `YASL_APP_QUIT` from an event
handler to exit. The runner handles dispatch, input polling, resize redraws,
and remaining surface/display cleanup. Display quit stops the runner; connection