compositor-drm: Rename fb_plane to scanout_plane
All planes being displayed have a framebuffer. What makes 'fb_plane'
special is that it's being displayed as the primary plane by KMS.
Previous patchsets renamed this to 'primary_plane' to match the KMS
terminology, namely the CRTC's base plane, which is controlled by
drmModeSetCrtc in the legacy API, and identified by PLANE_TYPE ==
"Primary" in the universal-plane API.
However, Weston uses 'primary_plane' internally to refer to the case
where client content is _not_ directly displayed on a plane, but
composited via the renderer, with the result of the compositing then
shown.
Rename to 'scanout_plane' as our least-ambiguous name, and document it a
bit.
Signed-off-by: Daniel Stone <daniels@collabora.com>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Reviewed-by: Emre Ucan <eucan@de.adit-jv.com>
diff --git a/libweston/compositor-drm.c b/libweston/compositor-drm.c
index decd586..b707a01 100644
--- a/libweston/compositor-drm.c
+++ b/libweston/compositor-drm.c
@@ -235,7 +235,8 @@
struct gbm_surface *gbm_surface;
uint32_t gbm_format;
- struct weston_plane fb_plane;
+ /* Plane for a fullscreen direct scanout view */
+ struct weston_plane scanout_plane;
/* The last framebuffer submitted to the kernel for this CRTC. */
struct drm_fb *fb_current;
@@ -721,7 +722,7 @@
drm_fb_set_buffer(output->fb_pending, buffer);
- return &output->fb_plane;
+ return &output->scanout_plane;
}
static struct drm_fb *
@@ -2784,10 +2785,10 @@
weston_plane_init(&output->cursor_plane, b->compositor,
INT32_MIN, INT32_MIN);
- weston_plane_init(&output->fb_plane, b->compositor, 0, 0);
+ weston_plane_init(&output->scanout_plane, b->compositor, 0, 0);
weston_compositor_stack_plane(b->compositor, &output->cursor_plane, NULL);
- weston_compositor_stack_plane(b->compositor, &output->fb_plane,
+ weston_compositor_stack_plane(b->compositor, &output->scanout_plane,
&b->compositor->primary_plane);
weston_log("Output %s, (connector %d, crtc %d)\n",
@@ -2830,7 +2831,7 @@
else
drm_output_fini_egl(output);
- weston_plane_release(&output->fb_plane);
+ weston_plane_release(&output->scanout_plane);
weston_plane_release(&output->cursor_plane);
drmModeFreeProperty(output->dpms_prop);