experiment with opaque material parameter layouts

Author: codex128

jme3-core/src/main/java/com/jme3/util/struct/Struct.java

@@ -86,7 +86,7 @@ public <E extends Struct> E bind(StructLayout layout) {
     public void computeOffsets() {
         this.size = 0;
         this.alignment = layout.getMinStructAlignment();
-        for (T f : fields) if (f.isEnabled()) {
+        for (T f : fields) {
             size = f.bind(this, size) + f.getSize();
             alignment = Math.max(alignment, f.getAlignment());
         }
@@ -161,7 +161,6 @@ public static class Field <T> implements StructField<T> {
         private Struct struct;
         private FieldDesc<T> description;
         private int offset;
-        private boolean enabled = true;
 
         public Field(T alias) {
             this(null, alias);
@@ -182,14 +181,12 @@ public int bind(Struct struct, int offset) {
 
         @Override
         public void set(T value) {
-            if (!enabled) return;
             assert description != null : "Struct not bound: unable to write.";
             description.write(struct.getLayout(), struct.getMapping(), struct.getPosition() + offset, value);
         }
 
         @Override
         public T get() {
-            if (!enabled) return alias;
             assert description != null : "Struct not bound: unable to read.";
             return alias = description.read(struct.getLayout(), struct.getMapping(), struct.getPosition() + offset, alias);
         }
@@ -209,16 +206,6 @@ public String getName() {
             return name;
         }
 
-        @Override
-        public void enable(boolean enable) {
-            this.enabled = enable;
-        }
-
-        @Override
-        public boolean isEnabled() {
-            return enabled;
-        }
-
         @Override
         public Class getType() {
             return alias.getClass();

jme3-core/src/main/java/com/jme3/util/struct/StructField.java

@@ -40,17 +40,6 @@ public interface StructField <T> {
      */
     T alias();
 
-    /**
-     * Enables or disables this field. When enabled, the field will be mapped to an offset
-     * relative to its struct and read/write from that location. When disabled, no data
-     * will be read or written on {@link #get()} or {@link #set()}.
-     *
-     * <p>If changed, the struct should be {@link Struct#computeOffsets() recomputed}.</p>
-     *
-     * @param enable true to enable this field
-     */
-    void enable(boolean enable);
-
     /**
      * Sets the name of this field. When created inside a {@link Struct}, the name will be
      * assigned reflectively if no name is assigned manually.
@@ -90,13 +79,6 @@ public interface StructField <T> {
      */
     int getAlignment();
 
-    /**
-     * Returns true if this field is {@link #enable(boolean) enabled}.
-     *
-     * @return true if enabled
-     */
-    boolean isEnabled();
-
     /**
      * Serializes {@link #alias()} to the proper memory address through
      * the bound field description.

jme3-core/src/main/java/com/jme3/vulkan/buffers/Mappable.java

@@ -1,7 +1,5 @@
 package com.jme3.vulkan.buffers;
 
-import com.jme3.vulkan.memory.MemorySize;
-
 public interface Mappable {
 
 }

jme3-core/src/main/java/com/jme3/vulkan/descriptors/DescriptorSet.java

@@ -23,7 +23,7 @@ public DescriptorSet(LogicalDevice<?> device, DescriptorPool pool, DescriptorSet
         this.object = id;
         if (pool.getFlags().contains(DescriptorPool.Create.FreeDescriptorSets)) {
             ref = DisposableManager.reference(this);
-            pool.getNativeReference().addDependent(ref);
+            pool.getReference().addDependent(ref);
         }
     }
 

jme3-core/src/main/java/com/jme3/vulkan/material/MaterialMapping.java

@@ -0,0 +1,12 @@
+package com.jme3.vulkan.material;
+
+import com.jme3.util.struct.Struct;
+import com.jme3.util.struct.StructSequence;
+
+public class MaterialMapping implements StructSequence<> {
+
+    public static class StructImpl extends Struct {
+
+    }
+
+}

jme3-core/src/main/java/com/jme3/vulkan/material/NewMaterial.java

@@ -1,14 +1,23 @@
 package com.jme3.vulkan.material;
 
 import com.jme3.material.RenderState;
+import com.jme3.math.ColorRGBA;
+import com.jme3.util.struct.Struct;
+import com.jme3.util.struct.StructField;
+import com.jme3.util.struct.StructMapping;
+import com.jme3.util.struct.StructSequence;
 import com.jme3.vulkan.buffers.BufferMapping;
 import com.jme3.vulkan.buffers.DirectBufferMapping;
+import com.jme3.vulkan.buffers.MappableBuffer;
 import com.jme3.vulkan.commands.CommandBuffer;
 import com.jme3.vulkan.descriptors.*;
 import com.jme3.vulkan.material.shader.ShaderStage;
+import com.jme3.vulkan.material.structs.UnshadedParams;
 import com.jme3.vulkan.material.technique.NewTechnique;
 import com.jme3.vulkan.material.technique.PushConstantRange;
 import com.jme3.vulkan.material.technique.VulkanTechnique;
+import com.jme3.vulkan.material.test.ShaderParameters;
+import com.jme3.vulkan.material.uniforms.StructUniform;
 import com.jme3.vulkan.material.uniforms.Uniform;
 import com.jme3.vulkan.material.uniforms.VulkanUniform;
 import com.jme3.vulkan.pipeline.Pipeline;
@@ -108,6 +117,109 @@ public RenderState getAdditionalRenderState() {
         return renderState;
     }
 
+    private final Map<StructUniform, StructMapping> paramMappings = new IdentityHashMap<>();
+
+    public StructField<ColorRGBA> getColor() {
+        StructUniform<MappableBuffer, UnshadedParams> s = getUniform("Parameters");
+        return new FieldMapping<>(s, s.getStruct().color);
+    }
+
+    public void flushParameters() {
+        for (StructMapping m : paramMappings.values()) {
+            m.close();
+        }
+        paramMappings.clear();
+    }
+
+    private void mapUniformBuffer() {}
+
+    public MyParams mapParameters() {
+        return new MyParams();
+    }
+
+    public class MyParams implements ShaderParameters {
+
+        private final Map<MappableBuffer, StructMapping> paramMappings = new IdentityHashMap<>();
+
+        @Override
+        public void close() {
+            for (StructMapping m : paramMappings.values()) {
+                m.close();
+            }
+        }
+
+        public StructField<ColorRGBA> getColor() {
+            StructUniform<MappableBuffer, UnshadedParams> s = getUniform("Parameters");
+            paramMappings.computeIfAbsent(s.get(), k -> k.mapStruct(s.getStruct()));
+            return s.getStruct().color;
+        }
+
+    }
+
+    private class FieldMapping <T> implements StructField<T> {
+
+        private final StructUniform<MappableBuffer, ? extends Struct> uniform;
+        private final StructField<T> delegate;
+        private StructMapping mapping;
+
+        public FieldMapping(StructUniform<MappableBuffer, ? extends Struct> uniform, StructField<T> delegate) {
+            this.uniform = uniform;
+            this.delegate = delegate;
+        }
+
+        @Override
+        public int bind(Struct struct, int offset) {
+            return delegate.bind(struct, offset);
+        }
+
+        @Override
+        public void set(T value) {
+            if (mapping == null) {
+                mapping = paramMappings.computeIfAbsent(uniform, StructUniform::map);
+            }
+            delegate.set(value);
+        }
+
+        @Override
+        public T get() {
+            if (mapping == null) {
+                mapping = paramMappings.computeIfAbsent(uniform, StructUniform::map);
+            }
+            return delegate.get();
+        }
+
+        @Override
+        public T alias() {
+            return delegate.alias();
+        }
+
+        @Override
+        public void setName(String name) {
+            delegate.setName(name);
+        }
+
+        @Override
+        public String getName() {
+            return delegate.getName();
+        }
+
+        @Override
+        public Class getType() {
+            return delegate.getType();
+        }
+
+        @Override
+        public int getSize() {
+            return delegate.getSize();
+        }
+
+        @Override
+        public int getAlignment() {
+            return delegate.getAlignment();
+        }
+
+    }
+
     protected static class CachedDescriptorSet {
 
         private final DescriptorSet set;

jme3-core/src/main/java/com/jme3/vulkan/material/test/ShaderParameters.java

@@ -0,0 +1,8 @@
+package com.jme3.vulkan.material.test;
+
+public interface ShaderParameters extends AutoCloseable {
+
+    @Override
+    void close();
+
+}

jme3-core/src/main/java/com/jme3/vulkan/material/uniforms/StructUniform.java

@@ -26,4 +26,8 @@ public StructMapping<S> map() {
         return get().mapAllStructs(struct);
     }
 
+    public S getStruct() {
+        return struct;
+    }
+
 }

jme3-core/src/main/java/com/jme3/vulkan/mesh/VertexBuffer.java

@@ -2,6 +2,7 @@
 
 import com.jme3.export.*;
 import com.jme3.util.struct.*;
+import com.jme3.vulkan.buffers.Mappable;
 import com.jme3.vulkan.buffers.MappableBuffer;
 import com.jme3.vulkan.tmp.Final;
 import com.jme3.vulkan.tmp.FinalWriter;

jme3-examples/src/main/java/jme3test/vulkan/TestJme4.java

@@ -5,6 +5,8 @@
 import com.jme3.backend.SimpleVulkanEngine;
 import com.jme3.material.Material;
 import com.jme3.math.ColorRGBA;
+import com.jme3.math.Vector3f;
+import com.jme3.math.Vector4f;
 import com.jme3.renderer.Camera;
 import com.jme3.renderer.RenderManager;
 import com.jme3.renderer.ViewPort;
@@ -17,6 +19,7 @@
 import com.jme3.util.struct.StructMapping;
 import com.jme3.vulkan.commands.StandardRenderSettings;
 import com.jme3.vulkan.material.structs.UnshadedParams;
+import com.jme3.vulkan.mesh.attributes.AttributeMapping;
 import com.jme3.vulkan.render.bucket.GeometryBucket;
 import com.sun.tools.javac.util.List;
 import org.graalvm.compiler.lir.amd64.AMD64BinaryConsumer;
@@ -37,11 +40,8 @@ public void simpleInitApp() {
 
         Geometry g = new Geometry("geom_jme4", new Box(1f, 1f, 1f));
         Material mat = engine.createMaterial("Common/MatDefs/Misc/Unshaded.j3md");
-        try (StructMapping<UnshadedParams> m = mat.mapStruct("Parameters")) {
-            UnshadedParams p = m.get();
-            p.color.set(ColorRGBA.Blue);
-            p.glowColor.set(ColorRGBA.Blue.mult(0.2f));
-            p.vertexColor.set(true);
+        try (MyParams p = mat.mapParameters()) {
+            p.getColor().set(ColorRGBA.Blue);
         }
         g.setMaterial(mat);
         rootNode.attachChild(g);