mirrors/wlroots
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wlroots/wlroots.git synced 2025-12-20 08:56:27 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Reformat doc comments

Browse source 
Unify the way we document our APIs. See CONTRIBUTING.md for the
rules.
This commit is contained in:
Simon Ser 2022-05-24 18:46:59 +02:00 • committed by Simon Zeni
parent 27383a1929
commit 28d89779af
65 changed files with 399 additions and 372 deletions
Download patch file Download diff file Expand all files Collapse all files

22
include/wlr/backend/wayland.h
View file

@ -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);