aboutsummaryrefslogtreecommitdiff
path: root/include/wlr/backend/wayland.h
blob: 770d6a03fd445dc9eb6393ae7a972443410b2949 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
#ifndef WLR_BACKEND_WAYLAND_H
#define WLR_BACKEND_WAYLAND_H
#include <stdbool.h>
#include <wayland-client.h>
#include <wayland-server-core.h>
#include <wlr/backend.h>
#include <wlr/types/wlr_output.h>

struct wlr_input_device;

/**
 * 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).
 */
struct wlr_backend *wlr_wl_backend_create(struct wl_display *display,
		const char *remote);

/**
 * Returns the remote struct wl_display used by the Wayland backend.
 */
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 new_output signal).
 */
struct wlr_output *wlr_wl_output_create(struct wlr_backend *backend);

/**
 * Check whether the provided backend is a Wayland backend.
 */
bool wlr_backend_is_wl(struct wlr_backend *backend);

/**
 * Check whether the provided input device is a Wayland input device.
 */
bool wlr_input_device_is_wl(struct wlr_input_device *device);

/**
 * 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 struct wlr_output which is a Wayland toplevel.
 */
void wlr_wl_output_set_title(struct wlr_output *output, const char *title);

/**
 * Returns the remote struct wl_surface used by the Wayland output.
 */
struct wl_surface *wlr_wl_output_get_surface(struct wlr_output *output);

#endif