From adad6514d4f42998b8ae16aa0ca1ea8031568743 Mon Sep 17 00:00:00 2001
From: Frank Praznik <[EMAIL REDACTED]>
Date: Mon, 15 May 2023 11:37:43 -0400
Subject: [PATCH] wayland: Add aspect-correct output for scaled modes
Add aspect-correct output of scaled video modes and a hint to control this behavior (aspect, stretch, or none).
The Wayland spec states that fullscreen surfaces that do not cover the entire output shall be centered with the borders masked by the compositor, so no additional work is required aside from calculating the proper window dimensions.
The default is still 'stretch' mode, as some window managers as of this time (KDE and older versions of GNOME still found in LTS distros) don't behave according to the spec and present an unmasked window that is not centered, so it's not yet safe to change the default.
---
include/SDL3/SDL_hints.h | 15 ++++++
src/video/wayland/SDL_waylandwindow.c | 77 ++++++++++++++++++++++++++-
2 files changed, 90 insertions(+), 2 deletions(-)
diff --git a/include/SDL3/SDL_hints.h b/include/SDL3/SDL_hints.h
index 544f323a0e87..d8a8416650c7 100644
--- a/include/SDL3/SDL_hints.h
+++ b/include/SDL3/SDL_hints.h
@@ -1784,6 +1784,21 @@ extern "C" {
*/
#define SDL_HINT_VIDEO_WAYLAND_MODE_EMULATION "SDL_VIDEO_WAYLAND_MODE_EMULATION"
+/**
+ * \brief A variable controlling how modes with a non-native aspect ratio are displayed under Wayland.
+ *
+ * When this hint is set, the requested scaling will be used when displaying fullscreen video modes
+ * that don't match the display's native aspect ratio. This is contingent on compositor viewport support.
+ *
+ * This variable can be set to the following values:
+ * "aspect" - Video modes will be displayed scaled, in their proper aspect ratio, with black bars.
+ * "stretch" - Video modes will be scaled to fill the entire display.
+ * "none" - Video modes will be displayed as 1:1 with no scaling.
+ *
+ * By default 'stretch' is used.
+ */
+#define SDL_HINT_VIDEO_WAYLAND_MODE_SCALING "SDL_VIDEO_WAYLAND_MODE_SCALING"
+
/**
* \brief Enable or disable mouse pointer warp emulation, needed by some older games.
*
diff --git a/src/video/wayland/SDL_waylandwindow.c b/src/video/wayland/SDL_waylandwindow.c
index fe52fe408412..ca09bc48af64 100644
--- a/src/video/wayland/SDL_waylandwindow.c
+++ b/src/video/wayland/SDL_waylandwindow.c
@@ -53,6 +53,51 @@ static SDL_bool FloatEqual(float a, float b)
return diff <= largest * SDL_FLT_EPSILON;
}
+/* According to the Wayland spec:
+ *
+ * "If the [fullscreen] surface doesn't cover the whole output, the compositor will
+ * position the surface in the center of the output and compensate with border fill
+ * covering the rest of the output. The content of the border fill is undefined, but
+ * should be assumed to be in some way that attempts to blend into the surrounding area
+ * (e.g. solid black)."
+ *
+ * - KDE, as of 5.27, still doesn't do this
+ * - GNOME prior to 43 didn't do this (older versions are still found in many LTS distros)
+ *
+ * Default to 'stretch' for now, until things have moved forward enough that the default
+ * can be changed to 'aspect'.
+ */
+enum WaylandModeScale
+{
+ WAYLAND_MODE_SCALE_UNDEFINED,
+ WAYLAND_MODE_SCALE_ASPECT,
+ WAYLAND_MODE_SCALE_STRETCH,
+ WAYLAND_MODE_SCALE_NONE
+};
+
+static enum WaylandModeScale GetModeScaleMethod()
+{
+ static enum WaylandModeScale scale_mode = WAYLAND_MODE_SCALE_UNDEFINED;
+
+ if (scale_mode == WAYLAND_MODE_SCALE_UNDEFINED) {
+ const char *scale_hint = SDL_GetHint(SDL_HINT_VIDEO_WAYLAND_MODE_SCALING);
+
+ if (scale_hint) {
+ if (!SDL_strcasecmp(scale_hint, "aspect")) {
+ scale_mode = WAYLAND_MODE_SCALE_ASPECT;
+ } else if (!SDL_strcasecmp(scale_hint, "none")) {
+ scale_mode = WAYLAND_MODE_SCALE_NONE;
+ } else {
+ scale_mode = WAYLAND_MODE_SCALE_STRETCH;
+ }
+ } else {
+ scale_mode = WAYLAND_MODE_SCALE_STRETCH;
+ }
+ }
+
+ return scale_mode;
+}
+
static SDL_bool SurfaceScaleIsFractional(SDL_Window *window)
{
SDL_WindowData *data = window->driverdata;
@@ -213,11 +258,39 @@ static void ConfigureWindowGeometry(SDL_Window *window)
if (data->is_fullscreen && window->fullscreen_exclusive) {
/* If the compositor supplied fullscreen dimensions, use them, otherwise fall back to the display dimensions. */
- const int output_width = data->requested_window_width ? data->requested_window_width : output->screen_width;
- const int output_height = data->requested_window_height ? data->requested_window_height : output->screen_height;
+ int output_width = data->requested_window_width ? data->requested_window_width : output->screen_width;
+ int output_height = data->requested_window_height ? data->requested_window_height : output->screen_height;
window_width = window->current_fullscreen_mode.w;
window_height = window->current_fullscreen_mode.h;
+ switch (GetModeScaleMethod()) {
+ case WAYLAND_MODE_SCALE_NONE:
+ /* The Wayland spec states that the advertised fullscreen dimensions are a maximum.
+ * Windows can request a smaller size, but exceeding these dimensions is a protocol violation,
+ * thus, modes that exceed the output size still need to be scaled with a viewport.
+ */
+ if (window_width <= output_width && window_height <= output_height) {
+ output_width = window_width;
+ output_height = window_height;
+
+ break;
+ }
+ SDL_FALLTHROUGH;
+ case WAYLAND_MODE_SCALE_ASPECT:
+ {
+ const float output_ratio = (float)output_width / (float)output_height;
+ const float mode_ratio = (float)window_width / (float)window_height;
+
+ if (output_ratio > mode_ratio) {
+ output_width = SDL_lroundf((float)window_width * ((float)output_height / (float)window_height));
+ } else if (output_ratio < mode_ratio) {
+ output_height = SDL_lroundf((float)window_height * ((float)output_width / (float)window_width));
+ }
+ } break;
+ default:
+ break;
+ }
+
window_size_changed = window_width != window->w || window_height != window->h ||
data->wl_window_width != output_width || data->wl_window_height != output_height;