aboutsummaryrefslogtreecommitdiff
path: root/include/wlr/backend/wayland.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/wlr/backend/wayland.h')
-rw-r--r--include/wlr/backend/wayland.h22
1 files changed, 11 insertions, 11 deletions
diff --git a/include/wlr/backend/wayland.h b/include/wlr/backend/wayland.h
index 0aed3aa1..a5b5e7a3 100644
--- a/include/wlr/backend/wayland.h
+++ b/include/wlr/backend/wayland.h
@@ -9,18 +9,18 @@
struct wlr_input_device;
/**
- * Creates a new wlr_wl_backend. This backend will be created with no outputs;
- * you must use wlr_wl_output_create to add them.
+ * Creates a new Wayland 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)
+ * default).
*/
struct wlr_backend *wlr_wl_backend_create(struct wl_display *display,
const char *remote);
/**
- * Returns the remote wl_display used by the Wayland backend.
+ * Returns the remote struct wl_display used by the Wayland backend.
*/
struct wl_display *wlr_wl_backend_get_remote_display(struct wlr_backend *backend);
@@ -28,37 +28,37 @@ struct wl_display *wlr_wl_backend_get_remote_display(struct wlr_backend *backend
* Adds a new output to this backend. You may remove outputs by destroying them.
* Note that if called before initializing the backend, this will return NULL
* and your outputs will be created during initialization (and given to you via
- * the output_add signal).
+ * the new_output signal).
*/
struct wlr_output *wlr_wl_output_create(struct wlr_backend *backend);
/**
- * True if the given backend is a wlr_wl_backend.
+ * Check whether the provided backend is a Wayland backend.
*/
bool wlr_backend_is_wl(struct wlr_backend *backend);
/**
- * True if the given input device is a wlr_wl_input_device.
+ * Check whether the provided input device is a Wayland input device.
*/
bool wlr_input_device_is_wl(struct wlr_input_device *device);
/**
- * True if the given output is a wlr_wl_output.
+ * Check whether the provided output device is a Wayland output device.
*/
bool wlr_output_is_wl(struct wlr_output *output);
/**
- * Sets the title of a wlr_output which is a Wayland window.
+ * Sets the title of a struct wlr_output which is a Wayland toplevel.
*/
void wlr_wl_output_set_title(struct wlr_output *output, const char *title);
/**
- * Returns the remote wl_surface used by the Wayland output.
+ * Returns the remote struct wl_surface used by the Wayland output.
*/
struct wl_surface *wlr_wl_output_get_surface(struct wlr_output *output);
/**
- * Returns the remote wl_seat for a Wayland input device.
+ * Returns the remote struct wl_seat for a Wayland input device.
*/
struct wl_seat *wlr_wl_input_device_get_seat(struct wlr_input_device *dev);