mirror of
https://gitlab.freedesktop.org/wlroots/wlroots.git
synced 2026-02-05 04:06:11 -05:00
4666fc78a0
This allows for a more robust an extensible way to advertise features that a backend is capable of.
107 lines
3.6 KiB
C
107 lines
3.6 KiB
C
/*
|
|
* This an unstable interface of wlroots. No guarantees are made regarding the
|
|
* future consistency of this API.
|
|
*/
|
|
#ifndef WLR_USE_UNSTABLE
|
|
#error "Add -DWLR_USE_UNSTABLE to enable unstable wlroots features"
|
|
#endif
|
|
|
|
#ifndef WLR_BACKEND_H
|
|
#define WLR_BACKEND_H
|
|
|
|
#include <wayland-server.h>
|
|
#include <wlr/backend/session.h>
|
|
#include <wlr/render/egl.h>
|
|
|
|
struct wlr_backend_impl;
|
|
|
|
enum wlr_backend_capability {
|
|
/*
|
|
* This backend supports input devices.
|
|
* New input devices are advertised with the 'new_input' event.
|
|
*/
|
|
WLR_BACKEND_CAP_INPUT = 1 << 0,
|
|
/*
|
|
* This backend supports graphical outputs.
|
|
* New outputs are advertised with the 'new_output' event.
|
|
*/
|
|
WLR_BACKEND_CAP_OUTPUT = 1 << 1,
|
|
/*
|
|
* This backend takes control of the login session or 'seat'.
|
|
* See the wlr_session type for more details.
|
|
*/
|
|
WLR_BACKEND_CAP_SESSION = 1 << 2,
|
|
/*
|
|
* This backend is capable of setting an output's mode (resolution) to
|
|
* an arbitrary value. If this is not supported, you must use a mode
|
|
* listed by the wlr_output.
|
|
*/
|
|
WLR_BACKEND_CAP_ARBITRARY_MODES = 1 << 3,
|
|
/*
|
|
* This backend supports setting cursors without requiring them to be
|
|
* composited to the main framebuffer. Some backends may have extra
|
|
* restrictions for what it can accept as a valid hardware cursor.
|
|
*/
|
|
WLR_BACKEND_CAP_HARDWARE_CURSOR = 1 << 4,
|
|
/*
|
|
* This backend supports accurate feedback for when a frame is
|
|
* presented to an output. This is relevant to the wp_presentation
|
|
* protocol.
|
|
*/
|
|
WLR_BACKEND_CAP_PRESENTATION_TIME = 1 << 5,
|
|
};
|
|
|
|
struct wlr_backend {
|
|
const struct wlr_backend_impl *impl;
|
|
uint32_t capabilities; // Bitmask of enum wlr_backend_capability
|
|
|
|
struct {
|
|
/** Raised when destroyed, passed the wlr_backend reference */
|
|
struct wl_signal destroy;
|
|
/** Raised when new inputs are added, passed the wlr_input_device */
|
|
struct wl_signal new_input;
|
|
/** Raised when new outputs are added, passed the wlr_output */
|
|
struct wl_signal new_output;
|
|
} events;
|
|
};
|
|
|
|
typedef struct wlr_renderer *(*wlr_renderer_create_func_t)(struct wlr_egl *egl, EGLenum platform,
|
|
void *remote_display, EGLint *config_attribs, EGLint visual_id);
|
|
/**
|
|
* Automatically initializes the most suitable backend given the environment.
|
|
* Will always return a multibackend. The backend is created but not started.
|
|
* Returns NULL on failure.
|
|
*
|
|
* The compositor can request to initialize the backend's renderer by setting
|
|
* the create_render_func. The callback must initialize the given wlr_egl and
|
|
* return a valid wlr_renderer, or NULL if it has failed to initiaze it.
|
|
* Pass NULL as create_renderer_func to use the backend's default renderer.
|
|
*/
|
|
struct wlr_backend *wlr_backend_autocreate(struct wl_display *display,
|
|
wlr_renderer_create_func_t create_renderer_func);
|
|
/**
|
|
* Start the backend. This may signal new_input or new_output immediately, but
|
|
* may also wait until the display's event loop begins. Returns false on
|
|
* failure.
|
|
*/
|
|
bool wlr_backend_start(struct wlr_backend *backend);
|
|
/**
|
|
* Destroy the backend and clean up all of its resources. Normally called
|
|
* automatically when the wl_display is destroyed.
|
|
*/
|
|
void wlr_backend_destroy(struct wlr_backend *backend);
|
|
/**
|
|
* Obtains the wlr_renderer reference this backend is using.
|
|
*/
|
|
struct wlr_renderer *wlr_backend_get_renderer(struct wlr_backend *backend);
|
|
/**
|
|
* Obtains the wlr_session reference from this backend if there is any.
|
|
* Might return NULL for backends that don't use a session.
|
|
*/
|
|
struct wlr_session *wlr_backend_get_session(struct wlr_backend *backend);
|
|
/**
|
|
* Returns the clock used by the backend for presentation feedback.
|
|
*/
|
|
clockid_t wlr_backend_get_presentation_clock(struct wlr_backend *backend);
|
|
|
|
#endif
|