wlseeds/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>

struct wlr_backend_impl {
	bool (*start)(struct wlr_backend *backend);
	void (*destroy)(struct wlr_backend *backend);
	int (*get_drm_fd)(struct wlr_backend *backend);
	uint32_t (*get_buffer_caps)(struct wlr_backend *backend);
};

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

#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 6 years ago			`/*`
			`* 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 7 years ago			`#ifndef WLR_BACKEND_INTERFACE_H`
			`#define WLR_BACKEND_INTERFACE_H`
Refactor backend state management 8 years ago
			`#include <stdbool.h>`
			`#include <wlr/backend.h>`

			`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. 7 years ago			`bool (start)(struct wlr_backend backend);`
Refactor out wlr_backend_state from wl/multi 7 years ago			`void (destroy)(struct wlr_backend backend);`
backend: add get_drm_fd to interface This function allows backends to return the DRM FD they are using. This will allow the allocator and the renderer to use the right device. 4 years ago			`int (get_drm_fd)(struct wlr_backend backend);`
backend: introduce backend_get_buffer_caps 4 years ago			`uint32_t (get_buffer_caps)(struct wlr_backend backend);`
Refactor backend state management 8 years ago			`};`

Write some more docs 7 years ago			`/**`
Reformat doc comments Unify the way we document our APIs. See CONTRIBUTING.md for the rules. 3 years ago			`* Initializes common state on a struct wlr_backend and sets the implementation`
			`* to the provided struct wlr_backend_impl reference.`
Write some more docs 7 years ago			`*/`
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. 7 years ago			`void wlr_backend_init(struct wlr_backend *backend,`
Refactor out wlr_backend_state from wl/multi 7 years ago			`const struct wlr_backend_impl *impl);`
backend: introduce wlr_backend_finish This new functions cleans up the common backend state. While this currently only emits the destroy signal, this will also clean up the renderer and allocator in upcoming patches. 4 years ago			`/**`
			`* Emit the destroy event and clean up common backend state.`
			`*/`
			`void wlr_backend_finish(struct wlr_backend *backend);`
Refactor backend state management 8 years ago
			`#endif`