mirror of
https://github.com/hyprwm/wlroots-hyprland.git
synced 2024-12-29 04:49:49 +01:00
28d89779af
Unify the way we document our APIs. See CONTRIBUTING.md for the rules.
65 lines
2 KiB
C
65 lines
2 KiB
C
#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);
|
|
|
|
/**
|
|
* 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);
|
|
|
|
#endif
|