Fix stale framebuffer attachments, leaked renderbuffers, and nonzero-default copies

jme3-core/src/main/java/com/jme3/texture/FrameBuffer.java

@@ -87,10 +87,23 @@ public class FrameBuffer extends NativeObject {
     private String name;
     private Boolean mipMapsGenerationHint = null;
 
+    // Not this FrameBuffer or NativeObject.handleRef: renderer-held targets must
+    // not keep the owner (or its phantom-reference handle) alive.
+    private final Object targetOwner = new Object();
+
     /**
      * <code>RenderBuffer</code> represents either a texture or a
      * buffer that will be rendered to. <code>RenderBuffer</code>s
      * are attached to an attachment slot on a <code>FrameBuffer</code>.
+     * <p>
+     * A target instance belongs to the first framebuffer to which it is added,
+     * even after removal or disposal. It cannot be transferred to another
+     * framebuffer or attached to multiple slots at once. A removed target may
+     * be added again to its original framebuffer.
+     * <p>
+     * To share a texture, create a separate target for each framebuffer using
+     * {@link FrameBufferTarget#newTarget(Texture)} with the same texture.
+     * Renderbuffer storage is owned exclusively by its framebuffer.
      */
     public static class RenderBuffer {
 
@@ -101,6 +114,7 @@ public static class RenderBuffer {
         int face = -1;
         int layer = -1;
         int level = 0;
+        private Object owner;
 
 
         public int getLevel() {
@@ -255,15 +269,34 @@ public static FrameBufferTextureTarget newTarget(Texture tx, TextureCubeMap.Face
     private FrameBuffer() {
     }
 
+    /**
+     * Adds an exclusively owned color renderbuffer target.
+     *
+     * @param colorBuf the target (not null)
+     * @throws IllegalArgumentException if the target belongs to another
+     * framebuffer or is already attached to this framebuffer
+     */
     public void addColorTarget(FrameBufferBufferTarget colorBuf){
+        claimTarget(colorBuf, null);
         colorBuf.slot=colorBufs.size();
         colorBufs.add(colorBuf);
+        setUpdateNeeded();
     }
 
+    /**
+     * Adds an exclusively owned color texture target. The underlying texture
+     * may be shared through distinct target instances.
+     *
+     * @param colorBuf the target (not null)
+     * @throws IllegalArgumentException if the target belongs to another
+     * framebuffer or is already attached to this framebuffer
+     */
     public void addColorTarget(FrameBufferTextureTarget colorBuf){
         // checkSetTexture(colorBuf.getTexture(), false);  // TODO: this won't work for levels.
+        claimTarget(colorBuf, null);
         colorBuf.slot=colorBufs.size();
         colorBufs.add(colorBuf);
+        setUpdateNeeded();
     }
 
     /**
@@ -274,13 +307,17 @@ public void addColorTarget(FrameBufferTextureTarget colorBuf){
      * 
      * @param i index of color target to replace
      * @param colorBuf color target to replace with
+     * @throws IllegalArgumentException if the target belongs to another
+     * framebuffer or is already attached to a different slot
      */
     public void replaceColorTarget(int i, FrameBufferTextureTarget colorBuf) {
         if (i < 0 || i >= colorBufs.size()) {
             throw new IndexOutOfBoundsException("No color target exists to replace at index=" + i);
         }
+        claimTarget(colorBuf, colorBufs.get(i));
         colorBuf.slot = i;
         colorBufs.set(i, colorBuf);
+        setUpdateNeeded();
     }
 
     /**
@@ -293,9 +330,15 @@ public void replaceColorTarget(int i, FrameBufferTextureTarget colorBuf) {
      */
     public void removeColorTarget(int i) {
         colorBufs.remove(i);
+        if (colorBufIndex > i) {
+            colorBufIndex--;
+        } else if (colorBufIndex == i && colorBufIndex == colorBufs.size()) {
+            colorBufIndex = Math.max(0, colorBufs.size() - 1);
+        }
         for (; i < colorBufs.size(); i++) {
             colorBufs.get(i).slot = i;
         }
+        setUpdateNeeded();
     }
 
     /**
@@ -304,25 +347,72 @@ public void removeColorTarget(int i) {
      *
      * @param colorBuf texture to add to the color Buffer
      * @param face position to add to the color buffer
+     * @throws IllegalArgumentException if the target belongs to another
+     * framebuffer or is already attached to this framebuffer
      */
     public void addColorTarget(FrameBufferTextureTarget colorBuf, TextureCubeMap.Face face) {
         // checkSetTexture(colorBuf.getTexture(), false);  // TODO: this won't work for levels.
+        int faceIndex = face.ordinal();
+        claimTarget(colorBuf, null);
         colorBuf.slot = colorBufs.size();
-        colorBuf.face = face.ordinal();
+        colorBuf.face = faceIndex;
         colorBufs.add(colorBuf);
+        setUpdateNeeded();
     }
 
+    /**
+     * Sets an exclusively owned depth renderbuffer target.
+     *
+     * @param depthBuf the depth target (not null)
+     * @throws IllegalArgumentException if the target is not a depth buffer,
+     * belongs to another framebuffer, or is already attached to another slot
+     */
     public void setDepthTarget(FrameBufferBufferTarget depthBuf){
         if (!depthBuf.getFormat().isDepthFormat())
             throw new IllegalArgumentException("Depth buffer format must be depth.");
+        claimTarget(depthBuf, this.depthBuf);
         this.depthBuf = depthBuf;
         this.depthBuf.slot =  this.depthBuf.getFormat().isDepthStencilFormat() ?  SLOT_DEPTH_STENCIL : SLOT_DEPTH;
+        setUpdateNeeded();
     }
 
+    /**
+     * Sets an exclusively owned depth texture target. The texture itself may
+     * be shared through distinct target instances.
+     *
+     * @param depthBuf the depth target (not null)
+     * @throws IllegalArgumentException if the texture is not a valid depth
+     * target, the target belongs to another framebuffer, or it is already
+     * attached to another slot
+     */
     public void setDepthTarget(FrameBufferTextureTarget depthBuf){
         checkSetTexture(depthBuf.getTexture(), true);
+        claimTarget(depthBuf, this.depthBuf);
         this.depthBuf = depthBuf;
         this.depthBuf.slot = depthBuf.getTexture().getImage().getFormat().isDepthStencilFormat() ?  SLOT_DEPTH_STENCIL : SLOT_DEPTH;
+        setUpdateNeeded();
+    }
+
+    private void claimTarget(RenderBuffer target, RenderBuffer replaced) {
+        if (target == null) {
+            throw new IllegalArgumentException("Framebuffer target cannot be null.");
+        }
+        if (target.owner != null && target.owner != targetOwner) {
+            throw new IllegalArgumentException("Framebuffer target belongs to another framebuffer. "
+                    + "Create a separate target for each framebuffer.");
+        }
+        if (target != replaced) {
+            if (target == depthBuf) {
+                throw new IllegalArgumentException("Framebuffer target is already attached.");
+            }
+            for (int i = 0; i < colorBufs.size(); i++) {
+                if (colorBufs.get(i) == target) {
+                    throw new IllegalArgumentException("Framebuffer target is already attached.");
+                }
+            }
+        }
+        // Keep the identity after removal: native detachment/deletion is deferred.
+        target.owner = targetOwner;
     }
 
     public int getNumColorTargets(){
@@ -474,6 +564,7 @@ public void setMultiTarget(boolean enabled) {
         } else {
             colorBufIndex = 0;
         }
+        setUpdateNeeded();
     }
 
     /**
@@ -499,7 +590,7 @@ public void setTargetIndex(int index) {
             throw new IllegalArgumentException("Target index must be between 0 and 16");
         }
 
-        if (colorBufs.size() < index) {
+        if (colorBufs.size() <= index) {
             throw new IllegalArgumentException("The target at " + index + " is not set!");
         }
 
@@ -568,6 +659,10 @@ public void setColorTexture(TextureCubeMap tex, TextureCubeMap.Face face) {
      */
     public void clearColorTargets() {
         colorBufs.clear();
+        if (colorBufIndex >= 0) {
+            colorBufIndex = 0;
+        }
+        setUpdateNeeded();
     }
 
     /**

jme3-core/src/main/java/com/jme3/util/NativeObjectManager.java

@@ -38,6 +38,7 @@
 import java.util.ArrayDeque;
 import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.IdentityHashMap;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
@@ -80,6 +81,7 @@ public class NativeObjectManager {
      * List of real objects requested by user for deletion.
      */
     private final ArrayDeque<NativeObject> userDeletionQueue = new ArrayDeque<>();
+    private final IdentityHashMap<NativeObject, Boolean> pendingUserDeletions = new IdentityHashMap<>();
 
     private static class NativeObjectRef extends PhantomReference<Object> {
 
@@ -116,6 +118,29 @@ public void registerObject(NativeObject obj) {
         }
     }
 
+    /**
+     * Unregisters an object explicitly deleted by a renderer. This is also safe
+     * when the manager has already unregistered it before calling the renderer.
+     *
+     * @param obj the deleted native object (not null, with its original ID)
+     */
+    public void unregisterObject(NativeObject obj) {
+        NativeObjectRef ref = refMap.remove(obj.getUniqueId());
+        if (ref != null) {
+            ref.clear();
+        }
+        // Managed deletion already removed the pending request before calling
+        // the renderer. Only a still-queued object needs this identity scan.
+        if (pendingUserDeletions.remove(obj) != null) {
+            userDeletionQueue.removeIf(queued -> queued == obj);
+            // The renderer deleted the native name, not the CPU buffers that
+            // the pending dispose() explicitly requested us to release.
+            if (UNSAFE) {
+                obj.deleteNativeBuffersInternal();
+            }
+        }
+    }
+
     private void deleteNativeObject(Object rendererObject, NativeObject obj, NativeObjectRef ref, 
                                     boolean deleteGL, boolean deleteBufs) {
         assert rendererObject != null;
@@ -178,6 +203,7 @@ public void deleteUnused(Object rendererObject){
         while (removed < MAX_REMOVES_PER_FRAME && !userDeletionQueue.isEmpty()) {
             // Remove user requested objects.
             NativeObject obj = userDeletionQueue.pop();
+            pendingUserDeletions.remove(obj);
             deleteNativeObject(rendererObject, obj, null, true, true);
             removed++;
         }
@@ -187,6 +213,11 @@ public void deleteUnused(Object rendererObject){
             if (ref == null) {
                 break;
             }
+            // Explicit deletion may have unregistered an already queued reference.
+            // Its native name can now belong to a different object.
+            if (refMap.get(ref.objClone.getUniqueId()) != ref) {
+                continue;
+            }
 
             deleteNativeObject(rendererObject, ref.objClone, ref, true, false);
             removed++;
@@ -209,6 +240,9 @@ public void deleteAllObjects(Object rendererObject){
             deleteNativeObject(rendererObject, ref.objClone, ref, true, false);
         }
         assert refMap.size() == 0;
+        // deleteUnused is bounded; the remaining GL objects were deleted via
+        // clones, but queued requests still own their CPU-buffer cleanup.
+        finishPendingDeletions();
     }
 
     /**
@@ -221,7 +255,9 @@ public void deleteAllObjects(Object rendererObject){
      * @param obj The object to mark as unused.
      */
     void enqueueUnusedObject(NativeObject obj) {
-        userDeletionQueue.push(obj);
+        if (pendingUserDeletions.put(obj, Boolean.TRUE) == null) {
+            userDeletionQueue.push(obj);
+        }
     }
 
     /**
@@ -241,6 +277,19 @@ public void resetObjects(){
         }
         refMap.clear();
         refQueue = new ReferenceQueue<Object>();
+        // Old native names must never be deleted in the new context. Losing
+        // the context does not, however, release explicitly disposed CPU buffers.
+        finishPendingDeletions();
+    }
+
+    private void finishPendingDeletions() {
+        while (!userDeletionQueue.isEmpty()) {
+            NativeObject obj = userDeletionQueue.pop();
+            pendingUserDeletions.remove(obj);
+            if (UNSAFE) {
+                obj.deleteNativeBuffersInternal();
+            }
+        }
     }
 
 //    public void printObjects(){