Deprecate CursorLoader and delete it from Desktop.cfg file

jme3-core/src/main/resources/com/jme3/asset/Desktop.cfg

@@ -1,4 +1,3 @@
 INCLUDE com/jme3/asset/General.cfg
 
 # Desktop-specific loaders
-LOADER com.jme3.cursors.plugins.CursorLoader : ani, cur, ico

jme3-core/src/plugins/java/com/jme3/cursors/plugins/CursorConverter.java

@@ -0,0 +1,185 @@
+/*
+ * Copyright (c) 2009-2026 jMonkeyEngine
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ *
+ * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
+ *   may be used to endorse or promote products derived from this software
+ *   without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.jme3.cursors.plugins;
+
+import java.nio.IntBuffer;
+import java.util.Arrays;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import com.jme3.math.ColorRGBA;
+import com.jme3.texture.Image;
+import com.jme3.texture.Texture2D;
+import com.jme3.texture.image.ImageRaster;
+import com.jme3.util.BufferUtils;
+
+/**
+ * Convert any image like object to a {@link JmeCursor}.
+ */
+public class CursorConverter {
+    /**
+     * Convert a {@link Texture2D} to a {@link JmeCursor}. The coordinate system used is the same specified
+     * in {@link JmeCursor}. The start point is 0, 0 being lower left.
+     * 
+     * @param cursorImage The texture to convert. No modifications will be applied.
+     * 
+     * @return The {@link JmeCursor} using a deep copy of {@link Texture2D.getImage}.
+     */
+    public static JmeCursor fromTexture(Texture2D cursorImage) {
+        Image image = cursorImage.getImage().clone();
+
+        int imageHeight = image.getHeight();
+        int imageWidth = image.getWidth();
+
+        IntBuffer adaptedImageData = getDataAsIntBuffer(image);
+
+        JmeCursor jmeCursor = new JmeCursor();
+        jmeCursor.setWidth(imageWidth);
+        jmeCursor.setHeight(imageHeight);
+        jmeCursor.setxHotSpot(0);
+        jmeCursor.setyHotSpot(imageHeight);
+        jmeCursor.setNumImages(1);
+        jmeCursor.setImagesDelay(null);
+        jmeCursor.setImagesData(adaptedImageData);
+        return jmeCursor;
+    }
+
+    private static IntBuffer getDataAsIntBuffer(Image image) {
+        int width = image.getWidth();
+        int height = image.getHeight();
+
+        ImageRaster raster = ImageRaster.create(image);
+
+        IntBuffer data = BufferUtils.createIntBuffer(width * height);
+
+        //ARGB color system is needed to show cursors correctly.
+        for (int y = 0; y < height; y++) {
+            for (int x = 0; x < width; x++) {
+                ColorRGBA color = raster.getPixel(x, y);
+
+                int a = (int) (color.a * 255) & 0xFF;
+                int r = (int) (color.r * 255) & 0xFF;
+                int g = (int) (color.g * 255) & 0xFF;
+                int b = (int) (color.b * 255) & 0xFF;
+
+                int argb = (a << 24) | (r << 16) | (g << 8) | b;
+
+                data.put(argb);
+            }
+        }
+
+        data.flip();
+        return data;
+    }
+
+    /**
+     * Convert a {@link Texture2D} array to a {@link JmeCursor} object that will represent an animated cursor,
+     * interpreting each {@link Texture2D} object as a frame of the animated cursor.
+     * The coordinate system used for each frame is the same specified in {@link JmeCursor}. The start point 
+     * is 0, 0 being lower left.
+     * 
+     * @param frameDelay The time delay that will take for a cursor to change from one frame to another.
+     * @param cursorFrames The frames that will make up the cursor animation. No modifications will be applied.
+     * 
+     * @return A {@link JmeCursor} object that contains the data for an animated cursor.
+     */
+    public static JmeCursor fromTextureFrames(int frameDelay, Texture2D[] cursorFrames) {
+        int[] frameRates = new int[cursorFrames.length];
+        Arrays.fill(frameRates, frameDelay);
+        return fromTextureFrames(frameRates, cursorFrames);
+    }
+
+    /**
+     * Convert a {@link Texture2D} array to a {@link JmeCursor} object that will represent an animated cursor, 
+     * interpreting each {@link Texture2D} object as a frame of the animated cursor.
+     * The coordinate system used for each frame is the same specified in {@link JmeCursor}. The start point 
+     * is 0, 0 being lower left.
+     * 
+     * @param frameDelays The time delay that will take each frame to change to the next frame. Because of it,
+     *                    it must contains as many delays as frames (lengths of cursorFrames and frameDelays 
+     *                    arrays must be equal).
+     * @param cursorFrames The frames that will make up the cursor animation. No modifications will be applied.
+     * 
+     * @return A {@link JmeCursor} object that contains the data for an animated cursor.
+     */
+    public static JmeCursor fromTextureFrames(int[] frameDelays, Texture2D[] cursorFrames) {
+        if (frameDelays.length != cursorFrames.length) {
+            throw new IllegalArgumentException("The lengths of cursorFrames and frameDelays arrays must be equal");
+        }
+
+        List<Image> imageFrames = Arrays.stream(cursorFrames)
+          //Avoid working and accidentally modifying original values
+          .map((frame) -> frame.getImage().clone())
+          .collect(Collectors.toList());
+
+        List<Integer> imageFrameHeights = imageFrames
+          .stream()
+          .map((image) -> image.getHeight())
+          .distinct()
+          .collect(Collectors.toList());
+
+        List<Integer> imageFrameWidths = imageFrames
+          .stream()
+          .map((image) -> image.getWidth())
+          .distinct()
+          .collect(Collectors.toList());
+
+        if (imageFrameHeights.size() > 1 || imageFrameWidths.size() > 1) {
+            throw new IllegalArgumentException("Some images from the Texture2D objects have different sizes");
+        }
+
+        int imageHeight = imageFrameHeights.get(0);
+        int imageWidth = imageFrameWidths.get(0);
+
+        IntBuffer imagesData = BufferUtils.createIntBuffer(imageHeight * imageWidth * cursorFrames.length);
+
+        List<IntBuffer> framesData = imageFrames
+          .stream()
+          .map((image) -> getDataAsIntBuffer(image))
+          .collect(Collectors.toList());
+
+        for (IntBuffer frameData : framesData) {
+            imagesData.put(frameData);
+        }
+        imagesData.flip();
+
+        JmeCursor jmeCursor = new JmeCursor();
+        jmeCursor.setWidth(imageWidth);
+        jmeCursor.setHeight(imageHeight);
+        jmeCursor.setxHotSpot(0);
+        jmeCursor.setyHotSpot(imageHeight);
+        jmeCursor.setNumImages(cursorFrames.length);
+        jmeCursor.setImagesDelay(BufferUtils.createIntBuffer(frameDelays));
+        jmeCursor.setImagesData(imagesData);
+        return jmeCursor;
+    }
+}

jme3-desktop/src/main/java/com/jme3/cursors/plugins/CursorLoader.java

@@ -51,9 +51,15 @@
 import javax.imageio.ImageIO;
 
 /**
+ * Supports loading of .ico, .ani, and .cur cursor file formats.
+ * 
  * Created Jun 5, 2012 9:45:58 AM
  * @author MadJack
+ * 
+ * @deprecated This class is not cross-platform, and the supported file formats are no longer commonly used.
+ *             Use {@link com.jme3.cursors.plugins.CursorConverter} instead.
  */
+@Deprecated
 public class CursorLoader implements AssetLoader {
     final private static int FDE_OFFSET = 6; // first directory entry offset
 

jme3-examples/src/main/java/jme3test/gui/TestCursor.java

@@ -1,8 +1,16 @@
 package jme3test.gui;
 
 import com.jme3.app.SimpleApplication;
+import com.jme3.cursors.plugins.CursorConverter;
 import com.jme3.cursors.plugins.JmeCursor;
+import com.jme3.texture.Image;
+import com.jme3.texture.image.ImageRaster;
+import com.jme3.texture.Texture2D;
+import com.jme3.math.ColorRGBA;
+
 import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.stream.Collectors;
 
 /**
  * This test class demonstrate how to change cursor in jME3.
@@ -34,29 +42,79 @@ public void simpleInitApp() {
 
         /*
          * To make jME3 use a custom cursor it is as simple as putting the
-         * .cur/.ico/.ani file in an asset directory. Here we use
+         * image file in an asset directory. Here we use
          * "Textures/GUI/Cursors".
          *
-         * For the purpose of this demonstration we load 3 different cursors and add them
-         * into an array list and switch cursor every 8 seconds.
+         * For the purpose of this demonstration we load 3 different cursors and
+         * switch cursor every 8 seconds.
          *
-         * The first ico has been made by Sirea and the set can be found here:
+         * At date of 2026/06/01:
+         * 
+         * The nyan cat cursor has been made by Sirea. Under the Attribution Required (CC by) license:
          * http://www.rw-designer.com/icon-set/nyan-cat
          *
-         * The second cursor has been made by Virum64 and is Public Domain.
+         * The meme face cursor has been made by Virum64. Released to Public Domain.
          * http://www.rw-designer.com/cursor-set/memes-faces-v64
          *
-         * The animated cursor has been made by Pointer Adic and can be found here:
+         * The animated monkey cursor has been made by Pointer Adic. Released to Public Domain:
          * http://www.rw-designer.com/cursor-set/monkey
+         * 
+         * The three cursor examples have been converted to png format.
+         * Checking and following the license restrictions in the process.
+         */
+
+        Image[] staticCursors = {
+            (Image) assetManager.loadAsset("Textures/Cursors/meme.png"),
+            (Image) assetManager.loadAsset("Textures/Cursors/nyancat.png"),
+        };
+
+        for (Image cursor : staticCursors) {
+            Image copyCursor = cursor.clone();
+            flipVertically(copyCursor);
+            cursors.add(CursorConverter.fromTexture(new Texture2D(copyCursor)));
+        }
+
+        /*
+         * For animated cursors. Each frame must be loaded.
          */
-        cursors.add((JmeCursor) assetManager.loadAsset("Textures/Cursors/meme.cur"));
-        cursors.add((JmeCursor) assetManager.loadAsset("Textures/Cursors/nyancat.ico"));
-        cursors.add((JmeCursor) assetManager.loadAsset("Textures/Cursors/monkey.ani"));
+
+        int monkeyFramesDelay = 60;
+        String[] monkeyFramePaths = {
+            "Textures/Cursors/monkey/frame_0001.png",
+            "Textures/Cursors/monkey/frame_0002.png",
+            "Textures/Cursors/monkey/frame_0003.png",
+            "Textures/Cursors/monkey/frame_0004.png",
+            "Textures/Cursors/monkey/frame_0005.png",
+            "Textures/Cursors/monkey/frame_0006.png"
+        };
+
+        Texture2D[] monkeyFrames = Arrays.stream(monkeyFramePaths)
+          .map(framePath -> ((Image) assetManager.loadAsset(framePath)).clone())
+          .peek(frameImage -> flipVertically(frameImage))
+          .map(frameImage -> new Texture2D(frameImage))
+          .toArray(Texture2D[]::new);
+
+        cursors.add(CursorConverter.fromTextureFrames(monkeyFramesDelay, monkeyFrames));
 
         sysTime = System.currentTimeMillis();
         inputManager.setMouseCursor(cursors.get(count));
     }
 
+    private void flipVertically(Image image) {
+        int height = image.getHeight();
+        int width = image.getWidth();
+
+        ImageRaster raster = ImageRaster.create(image);
+
+        for (int i = 0; i < width; i++) {
+            for (int j = 0; j < height / 2; j++){
+                ColorRGBA reserve = raster.getPixel(i, j);
+                raster.setPixel(i, j, raster.getPixel(i, height - j -1));
+                raster.setPixel(i, height - j -1, reserve);
+            }
+        }
+    }
+
     @Override
     public void simpleUpdate(float tpf) {
         long currentTime = System.currentTimeMillis();