feat: Unified method for detecting a Wayland session

jme3-core/src/main/java/com/jme3/system/JmeSystem.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2025 jMonkeyEngine
+ * Copyright (c) 2009-2026 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -31,9 +31,9 @@
  */
 package com.jme3.system;
 
-import com.jme3.asset.AssetManager;
-import com.jme3.audio.AudioRenderer;
-import com.jme3.input.SoftTextDialogInput;
+import com.jme3.asset.AssetManager;
+import com.jme3.audio.AudioRenderer;
+import com.jme3.input.SoftTextDialogInput;
 
 import java.io.File;
 import java.io.IOException;
@@ -48,11 +48,11 @@
 import java.util.logging.Logger;
 
 /**
- * Utility class to access platform-dependant features.
- */
-public class JmeSystem {
-
-    private static final Logger logger = Logger.getLogger(JmeSystem.class.getName());
+ * Utility class to access platform-dependant features.
+ */
+public class JmeSystem {
+
+    private static final Logger logger = Logger.getLogger(JmeSystem.class.getName());
 
     public enum StorageFolderType {
         Internal,
@@ -67,10 +67,10 @@ public enum StorageFolderType {
     private JmeSystem() {
     }
 
-    public static void setSystemDelegate(JmeSystemDelegate systemDelegate) {
-        JmeSystem.systemDelegate = systemDelegate;
-    }
-
+    public static void setSystemDelegate(JmeSystemDelegate systemDelegate) {
+        JmeSystem.systemDelegate = systemDelegate;
+    }
+
     public static synchronized File getStorageFolder() {
         return getStorageFolder(StorageFolderType.External);
     }
@@ -120,34 +120,34 @@ public static void setSoftTextDialogInput(SoftTextDialogInput input) {
      *
      * @param show If true, the keyboard is displayed, if false, the screen is hidden.
      */
-    public static void showSoftKeyboard(boolean show) {
-        checkDelegate();
-        systemDelegate.showSoftKeyboard(show);
-    }
-
-    public static boolean isDeviceRumbleSupported() {
-        checkDelegate();
-        return systemDelegate.isDeviceRumbleSupported();
-    }
-
-    public static void rumble(float amount) {
-        checkDelegate();
-        systemDelegate.rumble(amount);
-    }
-
-    public static void rumble(float amountHigh, float amountLow, float duration) {
-        checkDelegate();
-        systemDelegate.rumble(amountHigh, amountLow, duration);
-    }
-
-    public static void stopRumble() {
-        checkDelegate();
-        systemDelegate.stopRumble();
-    }
-
-    public static SoftTextDialogInput getSoftTextDialogInput() {
-        checkDelegate();
-        return systemDelegate.getSoftTextDialogInput();
+    public static void showSoftKeyboard(boolean show) {
+        checkDelegate();
+        systemDelegate.showSoftKeyboard(show);
+    }
+
+    public static boolean isDeviceRumbleSupported() {
+        checkDelegate();
+        return systemDelegate.isDeviceRumbleSupported();
+    }
+
+    public static void rumble(float amount) {
+        checkDelegate();
+        systemDelegate.rumble(amount);
+    }
+
+    public static void rumble(float amountHigh, float amountLow, float duration) {
+        checkDelegate();
+        systemDelegate.rumble(amountHigh, amountLow, duration);
+    }
+
+    public static void stopRumble() {
+        checkDelegate();
+        systemDelegate.stopRumble();
+    }
+
+    public static SoftTextDialogInput getSoftTextDialogInput() {
+        checkDelegate();
+        return systemDelegate.getSoftTextDialogInput();
     }
 
     /**
@@ -190,6 +190,17 @@ public static Platform getPlatform() {
         return systemDelegate.getPlatform();
     }
 
+    /**
+     * Detects if you are in a Wayland session.
+     *
+     * @return {@code true} if you are in a Waylnad session, otherwise it will
+     * be {@code false}
+     */
+    public static boolean isWaylandSession() {
+        checkDelegate();
+        return systemDelegate.isWaylandSession();
+    }
+
     public static JmeContext newContext(AppSettings settings, JmeContext.Type contextType) {
         checkDelegate();
         return systemDelegate.newContext(settings, contextType);

jme3-core/src/main/java/com/jme3/system/JmeSystemDelegate.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2021 jMonkeyEngine
+ * Copyright (c) 2009-2026 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -159,13 +159,13 @@ public boolean isDeviceRumbleSupported() {
         return false;
     }
 
-    @Override
-    public void rumble(float amountHigh, float amountLow, float duration) {
-    }
-
-    public final AssetManager newAssetManager(URL configFile) {
-        return new DesktopAssetManager(configFile);
-    }
+    @Override
+    public void rumble(float amountHigh, float amountLow, float duration) {
+    }
+
+    public final AssetManager newAssetManager(URL configFile) {
+        return new DesktopAssetManager(configFile);
+    }
 
     public final AssetManager newAssetManager() {
         return new DesktopAssetManager(null);
@@ -309,6 +309,14 @@ public Platform getPlatform() {
         }
     }
 
+    public boolean isWaylandSession() {
+        // The following matches the test GLFW does to enable the Wayland backend.
+        if ("wayland".equalsIgnoreCase(System.getenv("XDG_SESSION_TYPE")) && System.getenv("WAYLAND_DISPLAY") != null) {
+            return true;
+        }
+        return false;
+    }
+
     public String getBuildInfo() {
         StringBuilder sb = new StringBuilder();
         sb.append("Running on ").append(getFullName()).append("\n");

jme3-lwjgl3/src/main/java/com/jme3/system/lwjgl/LwjglCanvas.java

@@ -41,6 +41,7 @@
 import com.jme3.system.AppSettings;
 import com.jme3.system.Displays;
 import com.jme3.system.JmeCanvasContext;
+import com.jme3.system.JmeSystem;
 import com.jme3.system.lwjglx.LwjglxGLPlatform;
 
 import java.awt.AWTException;
@@ -703,14 +704,14 @@ protected void destroyContext() {
      */
     @Override
     protected void createContext(AppSettings settings) {
-        if (!settings.isX11PlatformPreferred() && isWayland()) {
+        if (!settings.isX11PlatformPreferred() && JmeSystem.isWaylandSession()) {
             LOGGER.log(Level.WARNING, "LWJGLX and AWT/Swing only work with X11, so XWayland will be used for GLX.");
         }
 
         // HACK: For LWJGLX to work in Wyland, it is necessary to use GLX via
         //       XWayland, so LWJGL must be forced to load GLX as a native API.
         //       This is because LWJGLX does not provide an EGL context.
-        if (isWayland()) {
+        if (JmeSystem.isWaylandSession()) {
             Configuration.OPENGL_CONTEXT_API.set("native");
         }
 

jme3-lwjgl3/src/main/java/com/jme3/system/lwjgl/LwjglWindow.java

@@ -438,10 +438,15 @@ private int[] getDisplayOrigin() {
 
     private void configureVideoDriverHints(AppSettings settings) {
         if (org.lwjgl.system.Platform.get() == org.lwjgl.system.Platform.LINUX) {
-            boolean isWaylandSession = "wayland".equalsIgnoreCase(System.getenv("XDG_SESSION_TYPE"));
+
+            /*
+             * Determine whether you want to use X11 or Wayland platform drivers. 
+             * This only works if you are in a Wayland session and want to force
+             * the use of X11 drivers through XWayland.
+             */
             if (settings.isX11PlatformPreferred()) {
                 SDL_SetHint(SDL_HINT_VIDEO_DRIVER, "x11");
-            } else if (isWaylandSession) {
+            } else if (JmeSystem.isWaylandSession()) {
                 SDL_SetHint(SDL_HINT_VIDEO_DRIVER, "wayland");
             }
         }
@@ -498,7 +503,7 @@ private void configureGLAttributes(AppSettings settings) {
         if (org.lwjgl.system.Platform.get() == org.lwjgl.system.Platform.LINUX) {
             if (settings.isX11PlatformPreferred()) {
                 SDL_GL_SetAttribute(SDL_GL_EGL_PLATFORM, EGL_PLATFORM_X11_EXT);
-            } else if ("wayland".equalsIgnoreCase(System.getenv("XDG_SESSION_TYPE"))) {
+            } else if (JmeSystem.isWaylandSession()) {
                 SDL_GL_SetAttribute(SDL_GL_EGL_PLATFORM, EGL_PLATFORM_WAYLAND_EXT);
             }
         }

jme3-lwjgl3/src/main/java/com/jme3/system/lwjglx/LwjglxDefaultGLPlatform.java

@@ -45,8 +45,11 @@ public final class LwjglxDefaultGLPlatform {
     /**
      * Detects if you are in a Wayland session.
      *
+     * @deprecated Use {@link com.jme3.system.JmeSystem#isWaylandSession() }
+     *
      * @return boolean
      */
+    @Deprecated
     public static boolean isWayland() {
         Platform platform = Platform.get();
         if (platform == LINUX || platform == FREEBSD) {