wlroots/include/wlr/backend/interface.h

/*
 * 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_INTERFACE_H
#define WLR_BACKEND_INTERFACE_H

#include <stdbool.h>
#include <wlr/backend.h>
#include <wlr/render/egl.h>

struct wlr_backend_impl {
	bool (*start)(struct wlr_backend *backend);
	void (*destroy)(struct wlr_backend *backend);
	struct wlr_renderer *(*get_renderer)(struct wlr_backend *backend);
};

/**
 * Initializes common state on a wlr_backend and sets the implementation to the
 * provided wlr_backend_impl reference.
 */
void wlr_backend_init(struct wlr_backend *backend,
		const struct wlr_backend_impl *impl);

#endif
Initial pass on API stability guarantees This introduces -DWLR_USE_UNSTABLE and adds information regarding the stability status to all headers. I started with a conservative set of headers to mark as stable: - types/wlr_matrix.h - util/edges.h - util/log.h - util/region.h - xcursor.h 2018-07-13 12:40:56 +00:00			`/*`
			`* 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`

Use more consistent include guard names 2017-09-23 08:26:01 +00:00			`#ifndef WLR_BACKEND_INTERFACE_H`
			`#define WLR_BACKEND_INTERFACE_H`
Refactor backend state management 2017-05-07 14:00:23 +00:00
			`#include <stdbool.h>`
			`#include <wlr/backend.h>`
Move egl.h to render/egl.h 2017-10-21 01:48:58 +00:00			`#include <wlr/render/egl.h>`
Refactor backend state management 2017-05-07 14:00:23 +00:00
			`struct wlr_backend_impl {`
wlr_backend_init -> wlr_backend_start Also renames create to init. We'll use create for anything that allocates and init for anything that takes a pointer and initializes it. 2017-08-13 13:59:14 +00:00			`bool (start)(struct wlr_backend backend);`
Refactor out wlr_backend_state from wl/multi 2017-08-12 15:43:36 +00:00			`void (destroy)(struct wlr_backend backend);`
Backport screenshooter fixes from the renderer redesign v1 This backports some changes to #319 to fix the screenshooter data format. This also adds wlr_backend_get_renderer which will be useful to support multiple renderers. 2018-01-23 21:06:54 +00:00			`struct wlr_renderer (get_renderer)(struct wlr_backend *backend);`
Refactor backend state management 2017-05-07 14:00:23 +00:00			`};`

Write some more docs 2018-03-19 19:46:28 +00:00			`/**`
			`* Initializes common state on a wlr_backend and sets the implementation to the`
			`* provided wlr_backend_impl reference.`
			`*/`
wlr_backend_init -> wlr_backend_start Also renames create to init. We'll use create for anything that allocates and init for anything that takes a pointer and initializes it. 2017-08-13 13:59:14 +00:00			`void wlr_backend_init(struct wlr_backend *backend,`
Refactor out wlr_backend_state from wl/multi 2017-08-12 15:43:36 +00:00			`const struct wlr_backend_impl *impl);`
Refactor backend state management 2017-05-07 14:00:23 +00:00
			`#endif`