wlroots/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)(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 2018-07-13 08:40:56 -04: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`

Fix some include guard names in interfaces/ 2017-09-23 13:10:10 +02:00			`#ifndef WLR_INTERFACES_WLR_OUTPUT_H`
			`#define WLR_INTERFACES_WLR_OUTPUT_H`
Use more consistent include guard names 2017-09-23 10:26:01 +02:00
Split out types.h and wlr/types.h TODO: Update the code accordingly and move other types into the same paradigm 2017-06-19 18:41:02 -04:00			`#include <stdbool.h>`
Reformat all #include directives 2018-02-12 21:29:23 +01:00			`#include <wlr/backend.h>`
Apply output transformation to pointer events in Wayland backend 2017-10-31 18:00:33 +01:00			`#include <wlr/types/wlr_box.h>`
Add pointer to backend inside wlr_output 2017-10-21 17:37:25 +13:00			`#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 2017-06-19 18:41:02 -04:00
			`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. 2018-05-01 21:38:04 +01:00			`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 2020-04-10 11:04:21 +02:00			`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. 2018-05-01 21:38:04 +01:00			`int32_t hotspot_x, int32_t hotspot_y, bool update_texture);`
Remove wlr_output_state, update backends 2017-08-13 10:51:50 -04:00			`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. 2019-04-23 19:26:21 +03:00			`bool (attach_render)(struct wlr_output output, int *buffer_age);`
output: introduce wlr_output_test 2020-04-02 12:41:19 +02:00			`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. 2019-04-23 19:26:21 +03:00			`bool (commit)(struct wlr_output output);`
Add wlr_output_impl.rollback Most of the pending output state is not forwarded to the backend prior to an output commit. For instance, wlr_output_set_mode just stashes the mode without calling any wlr_output_impl function. wlr_output_impl.commit is responsible for applying the pending mode. However, there are exceptions to this rule. The first one is wlr_output_attach_render. It won't go away before renderer v6 is complete, because it needs to set the current EGL surface. The second one is wlr_output_attach_buffer. wlr_output_impl.attach_buffer is removed in [1]. When wlr_output_rollback is called, all pending state is supposed to be cleared. This works for all the state except the two exceptions mentionned above. To fix this, introduce wlr_output_impl.rollback. Right now, the backend resets the current EGL surface. This prevents GL commands from affecting the output after wlr_output_rollback. This patch is required for FBO-based outputs to work properly. The compositor might be using FBOs for its own purposes [2], having leftover FBO state can have bad consequences. [1]: https://github.com/swaywm/wlroots/pull/2097 [2]: https://github.com/swaywm/wlroots/pull/2063#issuecomment-597614312 2020-04-06 11:53:20 +02:00			`void (rollback)(struct wlr_output output);`
output: make gamma size a size_t and gamma table const 2018-10-03 10:36:33 +02:00			`size_t (get_gamma_size)(struct wlr_output output);`
output, backend/drm: add wlr_output_export_dmabuf 2018-05-21 18:50:51 +01:00			`bool (export_dmabuf)(struct wlr_output output,`
Merge branch 'master' into screencontent 2018-05-31 12:33:27 +01:00			`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 2017-06-19 18:41:02 -04:00			`};`

Add pointer to backend inside wlr_output 2017-10-21 17:37:25 +13:00			`void wlr_output_init(struct wlr_output output, struct wlr_backend backend,`
Add wlr_output::enabled 2018-01-04 12:46:15 +01:00			`const struct wlr_output_impl impl, struct wl_display display);`
Add full refresh rate support to custom modes 2017-12-17 18:02:55 +01:00			`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 2018-01-04 12:46:15 +01:00			`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. 2019-04-23 20:22:42 +03:00			`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. 2018-04-18 00:15:25 +01:00			`void wlr_output_damage_whole(struct wlr_output *output);`
output: add wlr_output_schedule_frame 2018-01-26 22:39:23 +01:00			`void wlr_output_send_frame(struct wlr_output *output);`
output: add presentation refresh prediction 2018-10-02 12:11:09 +02:00			`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 2017-06-19 18:41:02 -04:00
			`#endif`