wlseeds/include/wlr/interfaces/wlr_output.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_INTERFACES_WLR_OUTPUT_H
#define WLR_INTERFACES_WLR_OUTPUT_H

#include <stdbool.h>
#include <wlr/backend.h>
#include <wlr/types/wlr_box.h>
#include <wlr/types/wlr_output.h>

struct wlr_output_impl {
	bool (*set_cursor)(struct wlr_output *output, struct wlr_texture *texture,
		float scale, enum wl_output_transform transform,
		int32_t hotspot_x, int32_t hotspot_y, bool update_texture);
	bool (*move_cursor)(struct wlr_output *output, int x, int y);
	void (*destroy)(struct wlr_output *output);
	bool (*attach_render)(struct wlr_output *output, int *buffer_age);
	bool (*test)(struct wlr_output *output);
	bool (*commit)(struct wlr_output *output);
	void (*rollback_render)(struct wlr_output *output);
	size_t (*get_gamma_size)(struct wlr_output *output);
	bool (*export_dmabuf)(struct wlr_output *output,
		struct wlr_dmabuf_attributes *attribs);
};

void wlr_output_init(struct wlr_output *output, struct wlr_backend *backend,
	const struct wlr_output_impl *impl, struct wl_display *display);
void wlr_output_update_mode(struct wlr_output *output,
	struct wlr_output_mode *mode);
void wlr_output_update_custom_mode(struct wlr_output *output, int32_t width,
	int32_t height, int32_t refresh);
void wlr_output_update_enabled(struct wlr_output *output, bool enabled);
void wlr_output_update_needs_frame(struct wlr_output *output);
void wlr_output_damage_whole(struct wlr_output *output);
void wlr_output_send_frame(struct wlr_output *output);
void wlr_output_send_present(struct wlr_output *output,
	struct wlr_output_event_present *event);

#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`

Fix some include guard names in interfaces/ 7 years ago			`#ifndef WLR_INTERFACES_WLR_OUTPUT_H`
			`#define WLR_INTERFACES_WLR_OUTPUT_H`
Use more consistent include guard names 7 years ago
Split out types.h and wlr/types.h TODO: Update the code accordingly and move other types into the same paradigm 8 years ago			`#include <stdbool.h>`
Reformat all #include directives 7 years ago			`#include <wlr/backend.h>`
Apply output transformation to pointer events in Wayland backend 7 years ago			`#include <wlr/types/wlr_box.h>`
Add pointer to backend inside wlr_output 7 years ago			`#include <wlr/types/wlr_output.h>`
Split out types.h and wlr/types.h TODO: Update the code accordingly and move other types into the same paradigm 8 years ago
			`struct wlr_output_impl {`
output: always use hardware cursors if available This changes the `wlr_output_impl.set_cursor` function to take a `wlr_texture` instead of a byte buffer. This simplifies the DRM and Wayland backends since they were creating textures from the byte buffer anyway. With this commit, performance should be improved when moving the cursor since outputs don't need to be re-rendered anymore. 7 years ago			`bool (set_cursor)(struct wlr_output output, struct wlr_texture *texture,`
output: fix blurred hw cursors with fractional scaling The scaling factor was being implicitly cast to an int. Closes: https://github.com/swaywm/sway/issues/4927 5 years ago			`float scale, enum wl_output_transform transform,`
output: always use hardware cursors if available This changes the `wlr_output_impl.set_cursor` function to take a `wlr_texture` instead of a byte buffer. This simplifies the DRM and Wayland backends since they were creating textures from the byte buffer anyway. With this commit, performance should be improved when moving the cursor since outputs don't need to be re-rendered anymore. 7 years ago			`int32_t hotspot_x, int32_t hotspot_y, bool update_texture);`
Remove wlr_output_state, update backends 7 years ago			`bool (move_cursor)(struct wlr_output output, int x, int y);`
			`void (destroy)(struct wlr_output output);`
output: refactor backend API This updates the backend part of the output API. This is mostly renaming: make_current becomes attach_render and swap_buffers becomes commit. This also fixes the RDP backend to support NULL damage. 6 years ago			`bool (attach_render)(struct wlr_output output, int *buffer_age);`
output: introduce wlr_output_test 5 years ago			`bool (test)(struct wlr_output output);`
output: refactor backend API This updates the backend part of the output API. This is mostly renaming: make_current becomes attach_render and swap_buffers becomes commit. This also fixes the RDP backend to support NULL damage. 6 years ago			`bool (commit)(struct wlr_output output);`
output: rename impl->rollback to rollback_render The output backend API is now mostly state-less thanks to the atomic hooks (commit and test). There is one exception though: attach_render. This function makes the rendering context current. However sometimes the compositor might decide not to render after attach_render (e.g. when there's nothing new to render to the back buffer). Thus wlr_output_rollback has been introduced to revert the pending state. Because the output backend API is mostly state-less, the only thing wlr_output_impl.rollback needs to do is revert the current rendering context. Rename the function to rollback_render to make this clear. Add a check in the common wlr_output code to only call rollback_render when attach_buffer has been previously called. On the long term, we'll be able to remove attach_render and rollback_render together. 4 years ago			`void (rollback_render)(struct wlr_output output);`
output: make gamma size a size_t and gamma table const 6 years ago			`size_t (get_gamma_size)(struct wlr_output output);`
output, backend/drm: add wlr_output_export_dmabuf 7 years ago			`bool (export_dmabuf)(struct wlr_output output,`
Merge branch 'master' into screencontent 7 years ago			`struct wlr_dmabuf_attributes *attribs);`
Split out types.h and wlr/types.h TODO: Update the code accordingly and move other types into the same paradigm 8 years ago			`};`

Add pointer to backend inside wlr_output 7 years ago			`void wlr_output_init(struct wlr_output output, struct wlr_backend backend,`
Add wlr_output::enabled 7 years ago			`const struct wlr_output_impl impl, struct wl_display display);`
Add full refresh rate support to custom modes 7 years ago			`void wlr_output_update_mode(struct wlr_output *output,`
			`struct wlr_output_mode *mode);`
			`void wlr_output_update_custom_mode(struct wlr_output *output, int32_t width,`
			`int32_t height, int32_t refresh);`
Add wlr_output::enabled 7 years ago			`void wlr_output_update_enabled(struct wlr_output *output, bool enabled);`
output: rename needs_commit to needs_frame This new name makes more sense, since it is a request from the backend to get a new frame. In the future a commit may not convey a new frame. 6 years ago			`void wlr_output_update_needs_frame(struct wlr_output *output);`
output: don't emit the mode event if it hasn't changed This also fixes #535. 7 years ago			`void wlr_output_damage_whole(struct wlr_output *output);`
output: add wlr_output_schedule_frame 7 years ago			`void wlr_output_send_frame(struct wlr_output *output);`
output: add presentation refresh prediction 6 years ago			`void wlr_output_send_present(struct wlr_output *output,`
			`struct wlr_output_event_present *event);`
Split out types.h and wlr/types.h TODO: Update the code accordingly and move other types into the same paradigm 8 years ago
			`#endif`