diff options
| author | Simon Ser <contact@emersion.fr> | 2022-05-24 18:46:59 +0200 |
|---|---|---|
| committer | Simon Zeni <simon@bl4ckb0ne.ca> | 2022-05-25 14:22:58 +0000 |
| commit | 28d89779af6de0340533b2674a98ab6ecc238599 (patch) | |
| tree | 255e8dfb440691f60facc805b0b75df94901fcd6 /include/wlr/backend/headless.h | |
| parent | 27383a1929348daf01e18349f215c998b6ef8c2f (diff) | |
Reformat doc comments
Unify the way we document our APIs. See CONTRIBUTING.md for the
rules.
Diffstat (limited to 'include/wlr/backend/headless.h')
| -rw-r--r-- | include/wlr/backend/headless.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/include/wlr/backend/headless.h b/include/wlr/backend/headless.h index ff55746f..2516f3a6 100644 --- a/include/wlr/backend/headless.h +++ b/include/wlr/backend/headless.h @@ -18,9 +18,9 @@ */ struct wlr_backend *wlr_headless_backend_create(struct wl_display *display); /** - * Create a new headless output backed by an in-memory EGL framebuffer. You can - * read pixels from this framebuffer via wlr_renderer_read_pixels but it is - * otherwise not displayed. + * Create a new headless output. + * + * The buffers presented on the output won't be displayed to the user. */ struct wlr_output *wlr_headless_add_output(struct wlr_backend *backend, unsigned int width, unsigned int height); |