Implement the viewporter protocol #2092

emersion · 2020-03-31T13:25:43Z

The viewporter protocol allows clients to ask the compositor to crop and scale buffers during composition. This allows clients to avoid having to crop and scale in an intermediary buffer. The use-cases are:

Xwayland games that expect to be able to perform modeset
Video players that present DMA-BUFs coming out of VA-API
Optimized scrolling in web browsers

TODO:

Apply viewport transforms to damage
Error out when src_width or src_height are not integers and destination size is not set
Compositor implementation: Add support for viewporter sway#5433

Test plan:

weston-scaler -s
weston-scaler -d
weston-scaler -b

Future plans: wire this up with direct scan-out. With my wlr_output_layer proposal, I think we can extend the API to allow compositors to feed src/dst rectangles to the backend:

/**
 * Set the layer's final size. If the size is different from the attached buffer's,
 * the buffer will be scaled.
 */
void wlr_output_layer_scale(struct wlr_output_layer *layer, int width, int height);
/**
 * Set the layer's source box. This defines what area of the buffer will be used
 * as a source. This can be used to crop the buffer.
 */
void wlr_output_layer_set_src_box(struct wlr_output_layer *layer,
        const struct wlr_fbox *box);

wlr_output_layer_scale maps directly to the CRTC_W and CRTC_H KMS properties. wlr_output_layer_set_buffer_src_box maps directly to the SRC_* KMS properties.

Closes: #633

Breaking change: renderer implementations need to be updated, render_texture_with_matrix has been replaced with render_subtexture_with_matrix which allows specifying a source rectangle.

types/wlr_surface.c

Depends on [1]. [1]: swaywm/wlroots#2092

emersion · 2020-06-08T13:55:02Z

include/wlr/render/wlr_renderer.h

@@ -32,6 +32,11 @@ struct wlr_renderer {
 	} events;
 };

+struct wlr_texture_box {


This isn't a very good name. Maybe something like wlr_fbox would be better?

texcoord is a vector of coordinates, with the first member being the X axis value and the second member being the Y axis value. It makes more sense to use the accessors with the same names.

Depends on [1]. [1]: swaywm/wlroots#2092

emersion · 2020-06-08T16:09:31Z

This is now ready for review.

ddevault · 2020-06-08T16:19:57Z

On a first pass, this LGTM. Would like @ascent12's thoughts and pending some discussions in IRC.

Same as wlr_box, but for floating-point numbers.

This renders only a subset of the texture, instead of the full texture.

This field contains the viewport source and destination parameters. It's intended to be updated by a third-party protocol, for instance viewporter.

Depends on [1]. [1]: swaywm/wlroots#2092

emersion · 2020-06-08T17:01:31Z

Removed the "breaking" label, this isn't a breaking change.

Update to use wlr_fbox.

emersion · 2020-06-08T17:02:06Z

Ah, this is a breaking change for custom renderers. My bad.

This helper allows compositors to retrieve the buffer source box in buffer-local coordinates.

Closes: swaywm#633

emersion · 2020-06-17T09:40:25Z

Ping @ascent12

ddevault · 2020-06-17T15:10:56Z

Thanks!

Depends on [1]. [1]: swaywm/wlroots#2092

emersion force-pushed the viewporter branch 2 times, most recently from 3c4f35e to 44a04ad Compare April 27, 2020 12:25

emersion mentioned this pull request May 22, 2020

Add support for wp_viewporter #2218

Closed

zzag reviewed May 27, 2020

View reviewed changes

types/wlr_surface.c Outdated Show resolved Hide resolved

emersion force-pushed the viewporter branch 2 times, most recently from d638b89 to 9ffc06f Compare June 8, 2020 12:11

emersion added a commit to emersion/sway that referenced this pull request Jun 8, 2020

Add support for viewporter

1e9f41a

Depends on [1]. [1]: swaywm/wlroots#2092

emersion mentioned this pull request Jun 8, 2020

Add support for viewporter swaywm/sway#5433

Merged

emersion commented Jun 8, 2020

View reviewed changes

emersion force-pushed the viewporter branch from 6b289ae to 925f900 Compare June 8, 2020 15:23

render/gles2: use .x/.y instead of .s/.t

54c3343

texcoord is a vector of coordinates, with the first member being the X axis value and the second member being the Y axis value. It makes more sense to use the accessors with the same names.

emersion added a commit to emersion/sway that referenced this pull request Jun 8, 2020

Add support for viewporter

8f6b399

Depends on [1]. [1]: swaywm/wlroots#2092

emersion force-pushed the viewporter branch from 323b6ba to 5f6b3a3 Compare June 8, 2020 16:03

emersion changed the title ~~[WIP] Implement the viewporter protocol~~ Implement the viewporter protocol Jun 8, 2020

emersion marked this pull request as ready for review June 8, 2020 16:09

emersion requested review from ascent12 and ddevault June 8, 2020 16:09

ddevault added the breaking Breaking change in public API label Jun 8, 2020

emersion added 4 commits June 8, 2020 18:45

box: add wlr_fbox

a70d5d1

Same as wlr_box, but for floating-point numbers.

util/region: add wlr_region_scale_xy

d342b53

render: add wlr_render_subtexture_with_matrix

4312fc3

This renders only a subset of the texture, instead of the full texture.

surface: add wlr_surface_state.viewport

010d201

This field contains the viewport source and destination parameters. It's intended to be updated by a third-party protocol, for instance viewporter.

emersion force-pushed the viewporter branch from 5f6b3a3 to 20c86ea Compare June 8, 2020 16:58

emersion added a commit to emersion/sway that referenced this pull request Jun 8, 2020

Add support for viewporter

9135735

Depends on [1]. [1]: swaywm/wlroots#2092

emersion removed the breaking Breaking change in public API label Jun 8, 2020

emersion added the breaking Breaking change in public API label Jun 8, 2020

emersion force-pushed the viewporter branch from 20c86ea to 4c2cb43 Compare June 8, 2020 17:07

emersion added 2 commits June 8, 2020 19:07

surface: introduce wlr_surface_get_buffer_source_box

cd8a837

This helper allows compositors to retrieve the buffer source box in buffer-local coordinates.

viewporter: new protocol implementation

4c2cb43

Closes: swaywm#633

ammen99 mentioned this pull request Jun 8, 2020

wp_viewporter protocol support WayfireWM/wayfire#553

Closed

emersion mentioned this pull request Jun 12, 2020

Fullscreen X11 games cannot use full resolution with 'scale 2' swaywm/sway#5444

Open

ascent12 approved these changes Jun 17, 2020

View reviewed changes

ddevault merged commit 9e68ed2 into swaywm:master Jun 17, 2020

emersion deleted the viewporter branch June 17, 2020 15:32

ddevault pushed a commit to swaywm/sway that referenced this pull request Jun 17, 2020

Add support for viewporter

e19bd1e

Depends on [1]. [1]: swaywm/wlroots#2092

emersion mentioned this pull request Jun 18, 2020

Add support for wp_viewporter ValveSoftware/gamescope#68

Open

bl4ckb0ne mentioned this pull request Jun 23, 2020

render/gles2: use glGetAttribLocation instead of hardcoded indices #2266

Merged

emersion added this to the 0.11.0 milestone Jul 15, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement the viewporter protocol #2092

Implement the viewporter protocol #2092

emersion commented Mar 31, 2020 •

edited

Loading

emersion Jun 8, 2020

emersion commented Jun 8, 2020

ddevault commented Jun 8, 2020

emersion commented Jun 8, 2020

emersion commented Jun 8, 2020

emersion commented Jun 17, 2020

ddevault commented Jun 17, 2020

Implement the viewporter protocol #2092

Implement the viewporter protocol #2092

Conversation

emersion commented Mar 31, 2020 • edited Loading

emersion Jun 8, 2020

Choose a reason for hiding this comment

emersion commented Jun 8, 2020

ddevault commented Jun 8, 2020

emersion commented Jun 8, 2020

emersion commented Jun 8, 2020

emersion commented Jun 17, 2020

ddevault commented Jun 17, 2020

emersion commented Mar 31, 2020 •

edited

Loading