wlroots/include/wlr/backend.h

71 lines
2.4 KiB
C
Raw Permalink Normal View History

/*
* 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
2017-05-07 14:00:23 +00:00
#include <wayland-server.h>
2017-07-11 07:18:34 +00:00
#include <wlr/backend/session.h>
2017-10-21 01:48:58 +00:00
#include <wlr/render/egl.h>
2017-05-07 14:00:23 +00:00
struct wlr_backend_impl;
struct wlr_backend {
const struct wlr_backend_impl *impl;
struct {
2018-03-19 19:46:28 +00:00
/** Raised when destroyed, passed the wlr_backend reference */
2017-12-19 23:14:47 +00:00
struct wl_signal destroy;
2018-03-19 19:46:28 +00:00
/** Raised when new inputs are added, passed the wlr_input_device */
struct wl_signal new_input;
2018-03-19 19:46:28 +00:00
/** Raised when new outputs are added, passed the wlr_output */
struct wl_signal new_output;
2017-05-07 14:00:23 +00:00
} 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);
2018-03-19 19:46:28 +00:00
/**
* 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.
2018-03-19 19:46:28 +00:00
*/
struct wlr_backend *wlr_backend_autocreate(struct wl_display *display,
wlr_renderer_create_func_t create_renderer_func);
2018-03-19 19:46:28 +00:00
/**
* 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);
2018-03-19 19:46:28 +00:00
/**
* Destroy the backend and clean up all of its resources. Normally called
* automatically when the wl_display is destroyed.
*/
2017-05-07 14:00:23 +00:00
void wlr_backend_destroy(struct wlr_backend *backend);
2018-03-19 19:46:28 +00:00
/**
* 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);
2018-10-01 20:44:33 +00:00
/**
* Returns the clock used by the backend for presentation feedback.
*/
clockid_t wlr_backend_get_presentation_clock(struct wlr_backend *backend);
#endif