aboutsummaryrefslogtreecommitdiff
path: root/include/wlr/backend/wayland.h
diff options
context:
space:
mode:
authorMarkus Ongyerth <ongy@ongy.net>2018-01-13 21:41:04 +0100
committerMarkus Ongyerth <ongy@ongy.net>2018-01-13 21:41:04 +0100
commitdfae5ff98f15ad65472cb2d39a8153ced14be1b8 (patch)
tree1b67c9e188e44dc0ebb170e5a2c3ad749e7291f3 /include/wlr/backend/wayland.h
parentc00e9d1416e609543b41d15550841a10a9b38632 (diff)
Update comment for wlr_headless_backend_create
Diffstat (limited to 'include/wlr/backend/wayland.h')
-rw-r--r--include/wlr/backend/wayland.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/include/wlr/backend/wayland.h b/include/wlr/backend/wayland.h
index 02ee5b2d..f89a6383 100644
--- a/include/wlr/backend/wayland.h
+++ b/include/wlr/backend/wayland.h
@@ -11,6 +11,10 @@
/**
* Creates a new wlr_wl_backend. This backend will be created with no outputs;
* you must use wlr_wl_output_create to add them.
+ *
+ * The `remote` argument is the name of the host compositor wayland socket. Set
+ * to NULL for the default behaviour (WAYLAND_DISPLAY env variable or wayland-0
+ * default)
*/
struct wlr_backend *wlr_wl_backend_create(struct wl_display *display, const char *remote);