Vulkan

Author: Eatgrapes

.github/workflows/build.yml

@@ -27,7 +27,15 @@ jobs:
 
       - name: Install Dependencies (Linux)
         if: contains(matrix.os, 'ubuntu')
-        run: sudo apt-get install -y libgles2-mesa-dev
+        run: sudo apt-get install -y libgles2-mesa-dev glslang-tools
+
+      - name: Install Dependencies (macOS)
+        if: contains(matrix.os, 'macos')
+        run: brew install glslang
+
+      - name: Install Dependencies (Windows)
+        if: contains(matrix.os, 'windows')
+        run: choco install glslang -y
 
       - name: Build Desktop
         run: python3 scripts/build.py desktop
@@ -61,6 +69,9 @@ jobs:
         with:
           ndk-version: r26b
 
+      - name: Install Vulkan Shader Compiler
+        run: sudo apt-get install -y glslang-tools
+
       - name: Build Android
         run: python3 scripts/build.py android
 

.github/workflows/release.yml

@@ -37,7 +37,15 @@ jobs:
 
       - name: Install Dependencies (Linux)
         if: contains(matrix.os, 'ubuntu')
-        run: sudo apt-get install -y libgles2-mesa-dev
+        run: sudo apt-get install -y libgles2-mesa-dev glslang-tools
+
+      - name: Install Dependencies (macOS)
+        if: contains(matrix.os, 'macos')
+        run: brew install glslang
+
+      - name: Install Dependencies (Windows)
+        if: contains(matrix.os, 'windows')
+        run: choco install glslang -y
 
       - name: Build Desktop
         run: python3 scripts/build.py desktop
@@ -70,6 +78,9 @@ jobs:
         with:
           ndk-version: r26b
 
+      - name: Install Vulkan Shader Compiler
+        run: sudo apt-get install -y glslang-tools
+
       - name: Build Android
         run: python3 scripts/build.py android
 
@@ -108,4 +119,4 @@ jobs:
           draft: false
           prerelease: false
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,14 +1,15 @@
 # Live2D-JavaBinding
 
-A native Java binding for the [Live2D Cubism SDK](https://www.live2d.com/en/sdk/about/), enabling seamless integration of Live2D models in Java applications (Suitable for OpenGL).
+A native Java binding for the [Live2D Cubism SDK](https://www.live2d.com/en/sdk/about/), enabling seamless integration of Live2D models in Java applications.
 
 For detailed documentation, please visit our [Wiki](https://github.com/Eatgrapes/Live2D-JavaBinding/wiki).
 
 ## Features
 
 - **Decoupled Distribution**: Java logic and native binaries are separated for flexibility. Native JARs are fully self-contained.
-- **Cross-Platform Support**: Compatible with Windows (x64), Linux (x64, arm64), and macOS (x64, arm64).
-- **OpenGL Based**: Designed for OpenGL-accelerated applications (e.g., LWJGL, JOGL).
+- **Cross-Platform Support**: OpenGL path works on existing supported desktop targets.
+- **Dual Backend**: Runtime switching via `CubismFramework.makeGL()` / `CubismFramework.makeVulkan(...)`.
+- **Vulkan Scope**: Vulkan backend is supported on **linux-x64** and **windows-x64** only.
 - **Simple and Intuitive API**: Easy-to-use interfaces for model loading, rendering, and interaction.
 - **JNI Integration**: Leverages Java Native Interface (JNI) for high-performance native code execution.
 
@@ -19,7 +20,7 @@ For detailed documentation, please visit our [Wiki](https://github.com/Eatgrapes
 - [x] **Motion System**: Playback with priority control and callbacks.
 - [x] **Parameter Control**: Manually set or get model parameter values.
 - [x] **Interaction**: Dragging support and hit detection.
-- [x] **Rendering**: OpenGL-based rendering and texture management.
+- [x] **Rendering**: OpenGL and Vulkan rendering paths.
 
 ## About JNI Integration
 
@@ -40,6 +41,7 @@ import dev.eatgrapes.live2d.CubismUserModel;
 
 // 1. Initialize the Framework
 CubismFramework.startUp();
+CubismFramework.makeGL(); // or CubismFramework.makeVulkan(...)
 CubismFramework.initialize();
 
 // 2. Load Model & Components
@@ -50,7 +52,8 @@ model.loadPhysics(physicsBytes); // Load physics data
 
 // 3. Setup Renderer
 model.createRenderer();
-model.registerTexture(0, openGLTextureId); // Bind textures
+model.registerTexture(0, openGLTextureId); // OpenGL texture
+// Vulkan: model.registerTextureVulkan(index, width, height, rgbaPixels);
 
 // 4. Handle Interactions & Motions
 model.setDragging(nx, ny); // Enable eye tracking or dragging
@@ -63,12 +66,17 @@ model.update(deltaTime); // Update model state
 model.draw(mvpMatrix);   // Render the model
 ```
 
+For Vulkan, update render target each frame before `draw`:
+```java
+model.setVulkanRenderTarget(vkImage, vkImageView, vkFormat, width, height);
+```
+
 ## Project Structure
 
 - **`binding/`**: Contains the Java API definitions and module configurations.
 - **`native/`**: Houses the JNI C++ implementation, along with CMake build scripts for native compilation.
 - **`scripts/`**: Python scripts for automating builds across all supported platforms.
-- **`example/`**: A complete Maven-based demo project using LWJGL 3 for OpenGL integration.
+- **`example/`**: LWJGL 3 demos for OpenGL (`Main`) and Vulkan (`VulkanMain`).
 
 ## Building the Project
 
@@ -77,6 +85,7 @@ model.draw(mvpMatrix);   // Render the model
 - CMake 3.10+
 - A C++14-compatible compiler (e.g., GCC, Clang, or MSVC)
 - JDK 9 or higher
+- Vulkan shader compiler (`glslangValidator` or `glslc`) when building shader resources
 
 ### Build Command
 Run the following in the project root:
@@ -89,6 +98,8 @@ This will generate artifacts in the `out/` directory:
 - `live2d-shared.jar`: The core Java API.
 - `live2d-native-[platform].jar`: Platform-specific native libraries (e.g., `live2d-native-windows-x64.jar`).
 
+OpenGL and Vulkan are bundled into the same shared/native dependencies. No extra Vulkan-only JAR is required.
+
 ## Contributing
 
 We welcome Pull Requests (PRs)! Whether it's implementing additional SDK features, enhancing platform support, or fixing bugs, your help is appreciated. Please follow these steps:

binding/src/main/java/dev/eatgrapes/live2d/CubismFramework.java

@@ -61,6 +61,62 @@ public static void startUp(LogCallback callback, LogLevel level) {
 
     private static native void startUpNative(boolean hasCallback, int logLevel);
 
+    /**
+     * Selects OpenGL as the renderer backend for newly created renderers.
+     * Call this before {@link dev.eatgrapes.live2d.CubismUserModel#createRenderer()}.
+     */
+    public static native void makeGL();
+
+    /**
+     * Selects Vulkan as the renderer backend for newly created renderers and sets
+     * required Vulkan shared context values.
+     * <p>
+     * Supported targets: Linux x64 and Windows x64.
+     * Call this before {@link dev.eatgrapes.live2d.CubismUserModel#createRenderer()}.
+     *
+     * @param device              VkDevice handle
+     * @param physicalDevice      VkPhysicalDevice handle
+     * @param commandPool         VkCommandPool handle
+     * @param queue               VkQueue handle
+     * @param swapchainImageCount swapchain image count
+     * @param width               render target width
+     * @param height              render target height
+     * @param imageView           VkImageView handle of current render target
+     * @param imageFormat         VkFormat value of render target
+     * @param depthFormat         VkFormat value for depth image
+     */
+    public static void makeVulkan(
+            long device,
+            long physicalDevice,
+            long commandPool,
+            long queue,
+            int swapchainImageCount,
+            int width,
+            int height,
+            long imageView,
+            int imageFormat,
+            int depthFormat
+    ) {
+        LibraryLoader.prepareVulkanShadersToDisk();
+        makeVulkanNative(
+                device, physicalDevice, commandPool, queue,
+                swapchainImageCount, width, height, imageView, imageFormat, depthFormat
+        );
+    }
+
+    private static native void makeVulkanNative(
+            long device,
+            long physicalDevice,
+            long commandPool,
+            long queue,
+            int swapchainImageCount,
+            int width,
+            int height,
+            long imageView,
+            int imageFormat,
+            int depthFormat
+    );
+
     /**
      * Initializes the framework resources.
      * Must be called after {@link #startUp()} and before using any other framework features.

binding/src/main/java/dev/eatgrapes/live2d/CubismUserModel.java

@@ -73,6 +73,32 @@ public CubismUserModel() {
     public void registerTexture(int index, int textureId) { registerTextureNative(_ptr, index, textureId); }
     private static native void registerTextureNative(long ptr, int index, int textureId);
 
+    /**
+     * Registers a texture for Vulkan renderer.
+     * @param index      The texture index (as defined in the model data).
+     * @param width      Texture width.
+     * @param height     Texture height.
+     * @param rgbaPixels Texture pixels in RGBA8 format.
+     */
+    public void registerTextureVulkan(int index, int width, int height, byte[] rgbaPixels) {
+        registerTextureVulkanNative(_ptr, index, width, height, rgbaPixels);
+    }
+    private static native void registerTextureVulkanNative(long ptr, int index, int width, int height, byte[] rgbaPixels);
+
+    /**
+     * Updates Vulkan render target for the current frame.
+     *
+     * @param image       VkImage handle
+     * @param imageView   VkImageView handle
+     * @param imageFormat VkFormat value
+     * @param width       Render target width
+     * @param height      Render target height
+     */
+    public void setVulkanRenderTarget(long image, long imageView, int imageFormat, int width, int height) {
+        setVulkanRenderTargetNative(_ptr, image, imageView, imageFormat, width, height);
+    }
+    private static native void setVulkanRenderTargetNative(long ptr, long image, long imageView, int imageFormat, int width, int height);
+
     /**
      * Sets the dragging coordinates for interaction (e.g., look-at behavior).
      * @param x The x-coordinate in model space.

binding/src/main/java/dev/eatgrapes/live2d/LibraryLoader.java

@@ -13,6 +13,18 @@
  */
 public class LibraryLoader {
     private static boolean loaded = false;
+    private static final String[] VULKAN_SHADER_FILES = {
+            "VertShaderSrcSetupMask.spv",
+            "FragShaderSrcSetupMask.spv",
+            "VertShaderSrc.spv",
+            "FragShaderSrc.spv",
+            "VertShaderSrcMasked.spv",
+            "FragShaderSrcMask.spv",
+            "FragShaderSrcMaskInverted.spv",
+            "FragShaderSrcPremultipliedAlpha.spv",
+            "FragShaderSrcMaskPremultipliedAlpha.spv",
+            "FragShaderSrcMaskInvertedPremultipliedAlpha.spv"
+    };
 
     /**
      * Loads the native library.
@@ -76,12 +88,42 @@ public static synchronized void load() {
      * @return The byte content of the shader file, or null if not found.
      */
     public static byte[] loadResource(String name) {
-        String internalPath = "/live2d/shaders/" + name.substring(name.lastIndexOf("/") + 1);
+        if (name == null || name.isEmpty()) return null;
+        String normalized = name.replace('\\', '/');
+        String fileName = normalized.substring(normalized.lastIndexOf('/') + 1);
+        String shaderGroup = fileName.endsWith(".spv") ? "vulkan" : "opengl";
+        String internalPath = "/live2d/shaders/" + shaderGroup + "/" + fileName;
         try (InputStream is = LibraryLoader.class.getResourceAsStream(internalPath)) {
             if (is == null) return null;
             return is.readAllBytes();
         } catch (IOException e) {
             return null;
         }
     }
-}
+
+    /**
+     * Ensures Vulkan SPIR-V shaders exist in the runtime working directory under {@code FrameworkShaders/}.
+     * This keeps compatibility with Cubism Vulkan shader loading paths.
+     */
+    public static synchronized void prepareVulkanShadersToDisk() {
+        Path shaderDir = Paths.get("FrameworkShaders");
+        try {
+            Files.createDirectories(shaderDir);
+            for (String fileName : VULKAN_SHADER_FILES) {
+                Path target = shaderDir.resolve(fileName);
+                if (Files.exists(target) && Files.size(target) > 0) {
+                    continue;
+                }
+                String internalPath = "/live2d/shaders/vulkan/" + fileName;
+                try (InputStream is = LibraryLoader.class.getResourceAsStream(internalPath)) {
+                    if (is == null) {
+                        throw new RuntimeException("Vulkan shader not found in resources: " + internalPath);
+                    }
+                    Files.copy(is, target, StandardCopyOption.REPLACE_EXISTING);
+                }
+            }
+        } catch (IOException e) {
+            throw new RuntimeException("Failed to prepare Vulkan shaders on disk", e);
+        }
+    }
+}