Make GLFence, SSBO, ComputeShader NativeObjects

Author: scott

jme3-core/src/main/java/com/jme3/renderer/Renderer.java

@@ -33,6 +33,7 @@
 
 import com.jme3.material.RenderState;
 import com.jme3.math.ColorRGBA;
+import com.jme3.renderer.opengl.GLFence;
 import com.jme3.scene.Mesh;
 import com.jme3.scene.VertexBuffer;
 import com.jme3.shader.bufferobject.BufferObject;
@@ -552,5 +553,11 @@ public default void pushDebugGroup(String name) {
 
     public void setShaderStorageBufferObject(int bindingPoint, BufferObject bufferObject) ;
     public void setUniformBufferObject(int bindingPoint, BufferObject bufferObject) ;
-    
+
+    public void deleteFence(GLFence fence);
+
+    /**
+     * Registers a NativeObject to be cleaned up by this renderer.
+     */
+    public void registerNativeObject(NativeObject nativeObject);
 }

jme3-core/src/main/java/com/jme3/renderer/opengl/ComputeShader.java

@@ -37,6 +37,7 @@
 import com.jme3.math.Vector4f;
 import com.jme3.renderer.RendererException;
 import com.jme3.util.BufferUtils;
+import com.jme3.util.NativeObject;
 
 import java.nio.FloatBuffer;
 import java.nio.IntBuffer;
@@ -46,16 +47,28 @@
  * <p>
  * Compute shaders require OpenGL 4.3 or higher.
  */
-public class ComputeShader {
+public class ComputeShader extends NativeObject {
 
     private final GL4 gl;
-    private final int programId;
+    private final String source;
     /**
      * Creates a new compute shader from GLSL source code.
      */
     public ComputeShader(GL4 gl, String source) {
+        super();
         this.gl = gl;
+        this.source = source;
+        //Load this upfront to surface any problems at init time
+        createComputeShader();
+    }
+    private ComputeShader(ComputeShader source){
+        super();
+        this.gl = source.gl;
+        this.id = source.id;
+        this.source = null;
+    }
 
+    private void createComputeShader(){
         // Create and compile the shader
         int shaderId = gl.glCreateShader(GL4.GL_COMPUTE_SHADER);
         if (shaderId <= 0) {
@@ -78,35 +91,40 @@ public ComputeShader(GL4 gl, String source) {
         }
 
         // Create program and link
-        programId = gl.glCreateProgram();
-        if (programId <= 0) {
+        id = gl.glCreateProgram();
+        if (id <= 0) {
             gl.glDeleteShader(shaderId);
             throw new RendererException("Failed to create shader program");
         }
 
-        gl.glAttachShader(programId, shaderId);
-        gl.glLinkProgram(programId);
+        gl.glAttachShader(id, shaderId);
+        gl.glLinkProgram(id);
 
         // Check link status
-        gl.glGetProgram(programId, GL.GL_LINK_STATUS, intBuf);
+        gl.glGetProgram(id, GL.GL_LINK_STATUS, intBuf);
         if (intBuf.get(0) != GL.GL_TRUE) {
-            gl.glGetProgram(programId, GL.GL_INFO_LOG_LENGTH, intBuf);
-            String infoLog = gl.glGetProgramInfoLog(programId, intBuf.get(0));
+            gl.glGetProgram(id, GL.GL_INFO_LOG_LENGTH, intBuf);
+            String infoLog = gl.glGetProgramInfoLog(id, intBuf.get(0));
             gl.glDeleteShader(shaderId);
-            gl.glDeleteProgram(programId);
+            gl.glDeleteProgram(id);
             throw new RendererException("Compute shader program linking failed: " + infoLog);
         }
 
         // Shader object can be deleted after linking
         gl.glDeleteShader(shaderId);
+
+        clearUpdateNeeded();
     }
 
     /**
      * Activates this compute shader for use.
      * Must be called before setting uniforms or dispatching.
      */
     public void makeActive() {
-        gl.glUseProgram(programId);
+        if(isUpdateNeeded()){
+            createComputeShader();
+        }
+        gl.glUseProgram(id);
     }
 
     /**
@@ -144,18 +162,35 @@ public void setUniform(int location, Matrix4f value) {
     }
 
     public int getUniformLocation(String name) {
-        return gl.glGetUniformLocation(programId, name);
+        return gl.glGetUniformLocation(id, name);
     }
 
     public void bindShaderStorageBuffer(int location, ShaderStorageBufferObject ssbo) {
-        gl.glBindBufferBase(GL4.GL_SHADER_STORAGE_BUFFER, location, ssbo.getBufferId());
+        gl.glBindBufferBase(GL4.GL_SHADER_STORAGE_BUFFER, location, ssbo.getId());
     }
 
-    /**
-     * Deletes this compute shader and releases GPU resources.
-     * The shader should not be used after calling this method.
-     */
-    public void delete() {
-        gl.glDeleteProgram(programId);
+    @Override
+    public void resetObject() {
+        id = INVALID_ID;
+        setUpdateNeeded();
+    }
+
+    @Override
+    public void deleteObject(Object rendererObject) {
+        if(id != INVALID_ID){
+            gl.glDeleteProgram(id);
+        }
+        resetObject();
+    }
+
+    @Override
+    public NativeObject createDestructableClone() {
+        return new ComputeShader(this);
+    }
+
+    @Override
+    public long getUniqueId() {
+        //Note this is the same type of ID as a regular shader.
+        return ((long)OBJTYPE_SHADER << 32) | (0xffffffffL & (long)id);
     }
 }

jme3-core/src/main/java/com/jme3/renderer/opengl/GLFence.java

@@ -31,6 +31,11 @@
  */
 package com.jme3.renderer.opengl;
 
+import com.jme3.renderer.Renderer;
+import com.jme3.util.NativeObject;
+
+import java.util.concurrent.atomic.AtomicInteger;
+
 /**
  * Wrapper for an OpenGL sync object (fence).
  * <p><a target="_blank" href="https://registry.khronos.org/OpenGL-Refpages/gl4/html/glFenceSync.xhtml">See here.</a></p>
@@ -45,38 +50,36 @@
  * @see GL4#glClientWaitSync(GLFence, int, long)
  * @see GL4#glDeleteSync(GLFence)
  */
-public class GLFence {
-
-    private final long handle;
+public class GLFence extends NativeObject {
+    private final static AtomicInteger nextUniqueId = new AtomicInteger(1);
     private Object nativeSync;
 
+
     /**
-     * Creates a new fence wrapper with the given handle.
-     *
-     * @param handle the native sync object handle (pointer)
+     * Most NativeObject implementations use the int handle GL returns as the NativeObjectId.
+     * However, fence IDs are actually longs.
+     * (This probably won't cause overflow issues; you're not likely to have 2 billion fences usefully around at once.)
      */
-    public GLFence(long handle) {
-        this.handle = handle;
-    }
+    private final long fenceId;
 
     /**
      * Creates a new fence wrapper with the given handle and native sync object.
      *
-     * @param handle the native sync object handle (pointer)
-     * @param nativeSync the backend-specific sync object (e.g., LWJGL2's GLSync)
+     * @param fenceId the native sync object handle (pointer)
+     * @param nativeSync the backend-specific sync object (e.g., LWJGL2's GLSync) or null
      */
-    public GLFence(long handle, Object nativeSync) {
-        this.handle = handle;
+    public GLFence(long fenceId, Object nativeSync) {
+        super();
+        this.fenceId = fenceId;
+        this.id = nextUniqueId.getAndIncrement();
         this.nativeSync = nativeSync;
+        clearUpdateNeeded();
     }
-
-    /**
-     * Returns the native sync object handle.
-     *
-     * @return the sync handle
-     */
-    public long getHandle() {
-        return handle;
+    private GLFence(GLFence source) {
+        super();
+        this.fenceId = source.fenceId;
+        this.nativeSync = source.nativeSync;
+        this.id = source.id;
     }
 
     /**
@@ -90,4 +93,29 @@ public long getHandle() {
     public Object getNativeSync() {
         return nativeSync;
     }
+    public long getFenceId() {
+        return fenceId;
+    }
+
+    @Override
+    public void resetObject() {
+        this.nativeSync = null;
+        this.id = INVALID_ID;
+        setUpdateNeeded();
+    }
+
+    @Override
+    public void deleteObject(Object rendererObject) {
+        ((Renderer)rendererObject).deleteFence(this);
+    }
+
+    @Override
+    public NativeObject createDestructableClone() {
+        return new GLFence(this);
+    }
+
+    @Override
+    public long getUniqueId() {
+        return ((long) OBJTYPE_FENCE << 32) | (0xffffffffL & (long) id);
+    }
 }

jme3-core/src/main/java/com/jme3/renderer/opengl/GLRenderer.java

@@ -3603,4 +3603,17 @@ public boolean isMainFrameBufferSrgb() {
     public GL4 getGl4(){
         return gl4;
     }
+
+    @Override
+    public void deleteFence(GLFence fence) {
+        if(gl4 != null && fence.getId() != NativeObject.INVALID_ID){
+            gl4.glDeleteSync(fence);
+            fence.resetObject();
+        }
+    }
+
+    @Override
+    public void registerNativeObject(NativeObject nativeObject) {
+        objManager.registerObject(nativeObject);
+    }
 }

jme3-core/src/main/java/com/jme3/renderer/opengl/ShaderStorageBufferObject.java

@@ -31,7 +31,9 @@
  */
 package com.jme3.renderer.opengl;
 
+import com.jme3.renderer.RendererException;
 import com.jme3.util.BufferUtils;
+import com.jme3.util.NativeObject;
 
 import java.nio.IntBuffer;
 
@@ -42,21 +44,33 @@
  * SSBOs are buffers that can be read from and written to by shaders.
  * SSBOs require OpenGL 4.3 or higher.
  */
-public class ShaderStorageBufferObject {
+public class ShaderStorageBufferObject extends NativeObject {
 
     private final GL4 gl;
-    private final int bufferId;
 
     /**
      * Creates a new SSBO.
      *
      * @param gl the GL4 interface (required for glBindBufferBase)
      */
     public ShaderStorageBufferObject(GL4 gl) {
+        super();
         this.gl = gl;
-        IntBuffer buf = BufferUtils.createIntBuffer(1);
-        gl.glGenBuffers(buf);
-        this.bufferId = buf.get(0);
+        ensureBufferReady();
+    }
+    private ShaderStorageBufferObject(ShaderStorageBufferObject source){
+        super();
+        this.gl = source.gl;
+        this.id = source.id;
+    }
+
+    private void ensureBufferReady(){
+        if(isUpdateNeeded()){
+            IntBuffer buf = BufferUtils.createIntBuffer(1);
+            gl.glGenBuffers(buf);
+            this.id = buf.get(0);
+            clearUpdateNeeded();
+        }
     }
 
     /**
@@ -76,7 +90,8 @@ public void initialize(int[] data) {
      * @param data the initial data to upload
      */
     public void initialize(IntBuffer data) {
-        gl.glBindBuffer(GL4.GL_SHADER_STORAGE_BUFFER, bufferId);
+        ensureBufferReady();
+        gl.glBindBuffer(GL4.GL_SHADER_STORAGE_BUFFER, id);
         gl.glBufferData(GL4.GL_SHADER_STORAGE_BUFFER, data, GL.GL_DYNAMIC_COPY);
     }
 
@@ -109,23 +124,41 @@ public void read(int[] destination) {
      * @param destination the buffer to read into
      */
     public void read(IntBuffer destination) {
-        gl.glBindBuffer(GL4.GL_SHADER_STORAGE_BUFFER, bufferId);
+        if(isUpdateNeeded()){
+            //If the SSBO was deleted from e.g. context restart, it probably isn't sensible to read from it.
+            //We could create a fresh empty buffer and read from that, but that might result in garbage data.
+            throw new RendererException("SSBO was not ready for read");
+        }
+        gl.glBindBuffer(GL4.GL_SHADER_STORAGE_BUFFER, id);
         gl.glGetBufferSubData(GL4.GL_SHADER_STORAGE_BUFFER, 0, destination);
         gl.glBindBuffer(GL4.GL_SHADER_STORAGE_BUFFER, 0);
     }
 
-    /**
-     * Deletes this buffer and releases GPU resources.
-     * The buffer should not be used after calling this method.
-     */
-    public void delete() {
-        IntBuffer buf = BufferUtils.createIntBuffer(1);
-        buf.put(bufferId);
-        buf.flip();
-        gl.glDeleteBuffers(buf);
+
+    @Override
+    public void resetObject() {
+        this.id = INVALID_ID;
+        setUpdateNeeded();
+    }
+
+    @Override
+    public void deleteObject(Object rendererObject) {
+        if(id != INVALID_ID){
+            IntBuffer buf = BufferUtils.createIntBuffer(1);
+            buf.put(id);
+            buf.flip();
+            gl.glDeleteBuffers(buf);
+        }
+        resetObject();
+    }
+
+    @Override
+    public NativeObject createDestructableClone() {
+        return new ShaderStorageBufferObject(this);
     }
 
-    public int getBufferId() {
-        return bufferId;
+    @Override
+    public long getUniqueId() {
+        return ((long) OBJTYPE_BO << 32) | (0xffffffffL & (long) id);
     }
 }