Introduce wlr_output_layer

This new API allows compositors to display buffers without needing to
perform rendering operations. This API can be implemented on Wayland
using subsurfaces and on DRM using KMS planes.

The goal is to make use of this API in a future scene-graph API.

References: https://github.com/swaywm/wlroots/issues/1826
This commit is contained in:
Simon Ser 2020-01-09 18:37:07 +01:00
parent 7429ba116f
commit 0fad58760a
No known key found for this signature in database
GPG key ID: 0FDE7BE0E88F5E48
7 changed files with 277 additions and 1 deletions

View file

@ -29,6 +29,8 @@ struct wlr_output_impl {
size_t (*get_gamma_size)(struct wlr_output *output);
bool (*export_dmabuf)(struct wlr_output *output,
struct wlr_dmabuf_attributes *attribs);
struct wlr_output_layer *(*create_layer)(struct wlr_output *output);
void (*destroy_layer)(struct wlr_output_layer *layer);
};
void wlr_output_init(struct wlr_output *output, struct wlr_backend *backend,
@ -44,4 +46,7 @@ void wlr_output_send_frame(struct wlr_output *output);
void wlr_output_send_present(struct wlr_output *output,
struct wlr_output_event_present *event);
void wlr_output_layer_init(struct wlr_output_layer *layer,
struct wlr_output *output);
#endif

View file

@ -60,6 +60,7 @@ enum wlr_output_state_field {
WLR_OUTPUT_STATE_SCALE = 1 << 4,
WLR_OUTPUT_STATE_TRANSFORM = 1 << 5,
WLR_OUTPUT_STATE_ADAPTIVE_SYNC_ENABLED = 1 << 6,
WLR_OUTPUT_STATE_LAYERS = 1 << 7,
};
enum wlr_output_state_buffer_type {
@ -94,6 +95,8 @@ struct wlr_output_state {
int32_t width, height;
int32_t refresh; // mHz, may be zero
} custom_mode;
struct wl_list layers; // wlr_output_layer.pending.link
};
struct wlr_output_impl;
@ -141,6 +144,8 @@ struct wlr_output {
bool frame_pending;
float transform_matrix[9];
struct wl_list layers; // wlr_output_layer.current.link
struct wlr_output_state pending;
// Commit sequence number. Incremented on each commit, may overflow.

View file

@ -0,0 +1,83 @@
/*
* 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_TYPES_WLR_OUTPUT_LAYER_H
#define WLR_TYPES_WLR_OUTPUT_LAYER_H
/**
* Output layers provide an API to display buffers without rendering them. It
* relies on backend features which are not always available: the backend can
* refuse to display a layer. However when the backend accepts to display a
* layer, performance and battery usage will be improved.
*
* Operations on output layers are double-buffered. An output commit is needed
* to apply the pending state.
*/
#include <wayland-server-core.h>
enum wlr_output_layer_state_field {
WLR_OUTPUT_LAYER_STATE_LINK = 1 << 0,
WLR_OUTPUT_LAYER_STATE_BUFFER = 1 << 1,
WLR_OUTPUT_LAYER_STATE_POSITION = 1 << 2,
};
struct wlr_output_layer_state {
uint32_t committed; // enum wlr_output_layer_state_field
struct wl_list link;
struct wlr_buffer *buffer; // only valid if WLR_OUTPUT_LAYER_STATE_BUFFER
int x, y; // only valid if WLR_OUTPUT_LAYER_STATE_POSITION
};
struct wlr_output_layer {
struct wlr_output *output;
/** If true, the backend has accepted to display the layer. If false, the
* compositor needs to manually render the layer. After each output commit,
* the backend will update this field. */
bool accepted;
struct wlr_output_layer_state current, pending;
};
/**
* Create a new output layer.
*/
struct wlr_output_layer *wlr_output_layer_create(struct wlr_output *output);
/**
* Remove the output layer. This operation is double-buffered, see
* wlr_output_commit.
*
* Callers must not access the wlr_output_layer after calling this function.
*/
void wlr_output_layer_remove(struct wlr_output_layer *layer);
/**
* Attach a buffer to the layer. This operation is double-buffered, see
* wlr_output_commit.
*/
void wlr_output_layer_attach_buffer(struct wlr_output_layer *layer,
struct wlr_buffer *buffer);
/**
* Set the position of the layer relative to the output. The coordinates are
* given in output-buffer-local coordinates. This operation is double-buffered,
* see wlr_output_commit.
*/
void wlr_output_layer_move(struct wlr_output_layer *layer, int x, int y);
/**
* Move the layer right above the specified sibling. This operation is
* double-buffered, see wlr_output_commit.
*/
void wlr_output_layer_place_above(struct wlr_output_layer *layer,
struct wlr_output_layer *sibling);
/**
* Move the layer right below the specified sibling. This operation is
* double-buffered, see wlr_output_commit.
*/
void wlr_output_layer_place_below(struct wlr_output_layer *layer,
struct wlr_output_layer *sibling);
#endif