Merge lp:~3v1n0/gnome-shell/bionic-patches-add-gpu-cached-texture into lp:~ubuntu-desktop/gnome-shell/ubuntu

[Marco Trevisan (Treviño)]

debian/patches/js-ui-Choose-some-actors-to-cache-on-the-GPU.patch: include duflu change

[lp:~3v1n0/gnome-shell/bionic-patches-add-gpu-cached-texture]

147. By Marco Trevisan (Treviño) on 2018-04-19

debian/patches/js-ui-Choose-some-actors-to-cache-on-the-GPU.patch: include duflu change

[Jeremy Bícha (jbicha)]

Ok. I uploaded this to the bionic queue. If you need this in before release or as a 0-day SRU, someone should talk to the Ubuntu Release Team.

review: Approve

[Daniel van Vugt (vanvugt)]

Thanks. Although that's not the current version of the upstream patch, it is functionally identical.

=== modified file 'debian/changelog'
--- debian/changelog	2018-04-18 11:40:07 +0000
+++ debian/changelog	2018-04-19 02:46:33 +0000
@@ -1,3 +1,11 @@
+gnome-shell (3.28.1-0ubuntu2) UNRELEASED; urgency=medium
+
+  * js-ui-Choose-some-actors-to-cache-on-the-GPU.patch:
+    - Improve rendering of shell elements moving rendering to GPU
+      (LP: #1744001)
+
+ -- Marco Trevisan (Treviño) <[e-mail]>  Wed, 18 Apr 2018 21:29:28 -0500
+
 gnome-shell (3.28.1-0ubuntu1) bionic; urgency=medium
 
   [ Jeremy Bicha ]
 
=== added file 'debian/patches/js-ui-Choose-some-actors-to-cache-on-the-GPU.patch'
--- debian/patches/js-ui-Choose-some-actors-to-cache-on-the-GPU.patch	1970-01-01 00:00:00 +0000
+++ debian/patches/js-ui-Choose-some-actors-to-cache-on-the-GPU.patch	2018-04-19 02:46:33 +0000
@@ -0,0 +1,133 @@
+From: Daniel van Vugt <[e-mail]>
+Date: Fri, 6 Apr 2018 05:26:58 -0500
+Subject: js/ui: Choose some actors to cache on the GPU
+
+Adds a wrapper function to flag actors that are good candidates for
+caching in texture memory (what Clutter calls "offscreen redirect"),
+thereby mostly eliminating their repaint overhead.
+
+This isn't exactly groundbreaking, it's how you're meant to use
+OpenGL in the first place. But the difficulty is in the design of
+Clutter which has some peculiarities making universal caching
+inefficient at the moment:
+
+ * Repainting an offscreen actor is measurably slower than repainting
+   the same actor if it was uncached. But only by less than 100%,
+   so if an actor can avoid changing every frame then caching is usually
+   more efficient over that timeframe.
+
+ * The cached painting from a container typically includes its children,
+   so you can't cache containers whose children are usually animating at
+   full frame rate. That results in a performance loss.
+     This could be remedied in future by Clutter explicitly separating a
+   container's background painting from its child painting and always
+   caching the background (as StWidget tries to in some cases already).
+
+So this commit selects just a few areas where caching has been verified
+to be beneficial, and many use cases now see their CPU usage halved:
+
+One small window active...... 10% -> 7% (-30%)
+...under a panel menu........ 23% -> 9% (-61%)
+One maximized window active.. 12% -> 9% (-25%)
+...under a panel menu........ 23% -> 11% (-52%)
+...under a shell dialog...... 22% -> 12% (-45%)
+...in activities overview.... 32% -> 17% (-47%)
+(on an i7-7700)
+
+Also a couple of bugs are fixed by this:
+
+https://bugzilla.gnome.org/show_bug.cgi?id=792634
+https://bugzilla.gnome.org/show_bug.cgi?id=792633
+
+Bug-GNOME: https://bugzilla.gnome.org/show_bug.cgi?id=792634
+Bug-GNOME: https://bugzilla.gnome.org/show_bug.cgi?id=792633
+Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/gnome-shell/+bug/1744001
+Forwarded: yes, https://gitlab.gnome.org/GNOME/gnome-shell/merge_requests/73
+---
+ js/ui/boxpointer.js |  1 +
+ js/ui/dash.js       |  1 +
+ js/ui/dialog.js     |  2 ++
+ js/ui/main.js       | 16 ++++++++++++++++
+ js/ui/panel.js      |  1 +
+ 5 files changed, 21 insertions(+)
+
+diff --git a/js/ui/boxpointer.js b/js/ui/boxpointer.js
+index 47f718a..602646a 100644
+--- a/js/ui/boxpointer.js
++++ b/js/ui/boxpointer.js
+@@ -44,6 +44,7 @@ var BoxPointer = new Lang.Class({
+                                   y_fill: true });
+         this._container = new Shell.GenericContainer();
+         this.actor.set_child(this._container);
++        Main.hintActorSeldomChanges(this.actor);
+         this._container.connect('get-preferred-width', this._getPreferredWidth.bind(this));
+         this._container.connect('get-preferred-height', this._getPreferredHeight.bind(this));
+         this._container.connect('allocate', this._allocate.bind(this));
+diff --git a/js/ui/dash.js b/js/ui/dash.js
+index 5ee2476..14864f1 100644
+--- a/js/ui/dash.js
++++ b/js/ui/dash.js
+@@ -402,6 +402,7 @@ var Dash = new Lang.Class({
+                                        clip_to_allocation: true });
+         this._box._delegate = this;
+         this._container.add_actor(this._box);
++        Main.hintActorSeldomChanges(this._container);
+ 
+         this._showAppsIcon = new ShowAppsIcon();
+         this._showAppsIcon.childScale = 1;
+diff --git a/js/ui/dialog.js b/js/ui/dialog.js
+index cfa192d..89db963 100644
+--- a/js/ui/dialog.js
++++ b/js/ui/dialog.js
+@@ -6,6 +6,7 @@ const GObject = imports.gi.GObject;
+ const Pango = imports.gi.Pango;
+ const St = imports.gi.St;
+ const Lang = imports.lang;
++const Main = imports.ui.main;
+ 
+ var Dialog = new Lang.Class({
+     Name: 'Dialog',
+@@ -40,6 +41,7 @@ var Dialog = new Lang.Class({
+         // mode accordingly so wrapped labels are handled correctly during
+         // size requests.
+         this._dialog.request_mode = Clutter.RequestMode.HEIGHT_FOR_WIDTH;
++        Main.hintActorSeldomChanges(this._dialog);
+ 
+         this.contentLayout = new St.BoxLayout({ vertical: true,
+                                                 style_class: "modal-dialog-content-box" });
+diff --git a/js/ui/main.js b/js/ui/main.js
+index d86cf9e..5277cf7 100644
+--- a/js/ui/main.js
++++ b/js/ui/main.js
+@@ -716,3 +716,19 @@ function showRestartMessage(message) {
+     let restartMessage = new RestartMessage(message);
+     restartMessage.open();
+ }
++
++/**
++ * hintActorSeldomChanges:
++ * @actor: A clutter actor
++ *
++ * Flag an actor as known to not need repainting very often. Such actors can
++ * have their painting cached in GPU memory so that future repaints triggered
++ * by other actors don't incur a repaint of @actor. This can provide dramatic
++ * performance benefits if used wisely.
++ *
++ * This hint needs to be provided manually because clutter presently lacks
++ * a good enough heuristic to toggle the optimization automatically.
++ */
++function hintActorSeldomChanges(actor) {
++    actor.set_offscreen_redirect(Clutter.OffscreenRedirect.ALWAYS);
++}
+diff --git a/js/ui/panel.js b/js/ui/panel.js
+index 2f59324..2237ead 100644
+--- a/js/ui/panel.js
++++ b/js/ui/panel.js
+@@ -772,6 +772,7 @@ var Panel = new Lang.Class({
+         this.actor = new Shell.GenericContainer({ name: 'panel',
+                                                   reactive: true });
+         this.actor._delegate = this;
++        Main.hintActorSeldomChanges(this.actor);
+ 
+         this._sessionStyle = null;
+ 
 
=== modified file 'debian/patches/series'
--- debian/patches/series	2018-04-18 11:33:34 +0000
+++ debian/patches/series	2018-04-19 02:46:33 +0000
@@ -26,3 +26,4 @@
 workspace-fix-repositioned-windows-in-activities.patch
 st-texture-cache-Cancel-sliced-image-loading-on-target-ac.patch
 st-texture-cache-Don-t-add-NULL-textures-to-cache.patch
+js-ui-Choose-some-actors-to-cache-on-the-GPU.patch