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 (*enable)(struct wlr_output *output, bool enable);
	bool (*set_mode)(struct wlr_output *output, struct wlr_output_mode *mode);
	bool (*set_custom_mode)(struct wlr_output *output, int32_t width,
		int32_t height, int32_t refresh);
	void (*transform)(struct wlr_output *output,
		enum wl_output_transform transform);
	bool (*set_cursor)(struct wlr_output *output, struct wlr_texture *texture,
		int32_t 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 (*make_current)(struct wlr_output *output, int *buffer_age);
	bool (*swap_buffers)(struct wlr_output *output, pixman_region32_t *damage);
	bool (*set_gamma)(struct wlr_output *output, size_t size,
		const uint16_t *r, const uint16_t *g, const uint16_t *b);
	size_t (*get_gamma_size)(struct wlr_output *output);
	bool (*export_dmabuf)(struct wlr_output *output,
		struct wlr_dmabuf_attributes *attribs);
	void (*schedule_frame)(struct wlr_output *output);
};

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_swap(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: make wlr_output_enable return a bool 2018-09-14 18:18:07 +02:00			`bool (enable)(struct wlr_output output, bool enable);`
Remove wlr_output_state, update backends 2017-08-13 10:51:50 -04:00			`bool (set_mode)(struct wlr_output output, struct wlr_output_mode *mode);`
Add wlr_output_set_custom_mode 2017-12-11 12:14:23 +01:00			`bool (set_custom_mode)(struct wlr_output output, int32_t width,`
			`int32_t height, int32_t refresh);`
Remove wlr_output_state, update backends 2017-08-13 10:51:50 -04:00			`void (transform)(struct wlr_output output,`
Allow to update the cursor hotspot without its pixels 2017-10-12 09:40:51 +02:00			`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			`bool (set_cursor)(struct wlr_output output, struct wlr_texture *texture,`
Fix hardware cursors scale & transform 2018-05-09 19:58:18 +01:00			`int32_t 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: add damage tracking via buffer age 2018-01-21 00:06:35 +01:00			`bool (make_current)(struct wlr_output output, int *buffer_age);`
Swap buffers with damage 2018-02-09 22:54:14 +01:00			`bool (swap_buffers)(struct wlr_output output, pixman_region32_t *damage);`
output: make gamma size a size_t and gamma table const 2018-10-03 10:36:33 +02:00			`bool (set_gamma)(struct wlr_output output, size_t size,`
			`const uint16_t r, const uint16_t g, const uint16_t *b);`
			`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);`
output: don't trigger a frame immediately in schedule_frame This desynchronizes our rendering loop with the vblank cycle. In case a compositor doesn't swap buffers but schedules a frame, emitting a frame event immediately enters a busy-loop. Instead, ask the backend to send a frame when appropriate. On Wayland we can just register a frame callback on our surface. On DRM we can do a no-op pageflip. Fixes #617 Fixes swaywm/sway#2748 2018-10-05 16:14:22 +02:00			`void (schedule_frame)(struct wlr_output output);`
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);`
backend/drm: fix hardware cursors not moving This adds back `wlr_output::needs_swap`. This allows a backend to request buffer swaps even if the output isn't damaged. This is needed by the DRM backend to trigger pageflips when the cursor moves. 2018-01-20 16:43:14 +01:00			`void wlr_output_update_needs_swap(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`