experiment with material parameter handling

Author: codex128

jme3-core/src/main/java/com/jme3/backend/Engine.java

@@ -3,11 +3,6 @@
 
 import com.jme3.material.Material;
 import com.jme3.renderer.ViewPort;
-import com.jme3.texture.Texture;
-import com.jme3.util.struct.Struct;
-import com.jme3.util.struct.StructLayout;
-import com.jme3.vulkan.buffers.saving.BufferAllocator;
-import com.jme3.vulkan.material.uniforms.Uniform;
 
 import java.util.Collection;
 

jme3-core/src/main/java/com/jme3/material/Material.java

@@ -32,13 +32,7 @@
 package com.jme3.material;
 
 import com.jme3.scene.Geometry;
-import com.jme3.util.struct.Struct;
-import com.jme3.util.struct.StructMapping;
-import com.jme3.vulkan.buffers.MappableBuffer;
-import com.jme3.vulkan.material.technique.NewTechnique;
-import com.jme3.vulkan.material.uniforms.BufferUniform;
-import com.jme3.vulkan.material.uniforms.StructUniform;
-import com.jme3.vulkan.material.uniforms.Uniform;
+import com.jme3.vulkan.material.experimental.ShaderInterface;
 
 /**
  * <code>Material</code> describes the rendering style for a given
@@ -53,49 +47,14 @@
  */
 public interface Material {
 
-    void selectTechnique(String name);
+    void setParameter(String name, Object value);
 
-    void setTechnique(String name, NewTechnique technique);
+    <P> P getParameter(String name);
 
-    NewTechnique getActiveTechnique();
+    void enableInterface(Class<? extends ShaderInterface> interfaceType, boolean enable);
 
-    NewTechnique getTechnique(String name);
-
-    <T extends Uniform> T setUniform(String name, T uniform);
-
-    <T extends Uniform> T getUniform(String name);
+    boolean isInterfaceEnabled(Class<? extends ShaderInterface> interfaceType);
 
     RenderState getAdditionalRenderState();
 
-    default int getSortId() {
-        return 0;
-    }
-
-    default <T extends Uniform> T getUniform(String name, Class<T> type) {
-        return getUniform(name);
-    }
-
-    default void set(String name, Object value) {
-        getUniform(name).set(value);
-    }
-
-    default <T> T get(String name) {
-        Uniform<T> u = getUniform(name);
-        return u.get();
-    }
-
-    default <T> T get(String name, Class<T> type) {
-        return get(name);
-    }
-
-    default <T extends Struct> StructMapping<T> mapStruct(String name, T struct) {
-        BufferUniform u = getUniform(name);
-        return u.map(struct);
-    }
-
-    default <T extends Struct> StructMapping<T> mapStruct(String name) {
-        StructUniform<MappableBuffer, T> u = getUniform(name);
-        return u.map();
-    }
-
 }

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

@@ -0,0 +1,8 @@
+package com.jme3.util;
+
+public interface SafeCloseable extends AutoCloseable {
+
+    @Override
+    void close();
+
+}

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

@@ -1,13 +1,13 @@
 package com.jme3.util.struct;
 
-import com.jme3.export.JmeExporter;
-import com.jme3.export.JmeImporter;
-import com.jme3.export.Savable;
+import com.jme3.export.*;
 import com.jme3.math.FastMath;
 import com.jme3.vulkan.buffers.BufferMapping;
 
 import java.io.IOException;
 import java.util.*;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 /**
  * Defines the layout of properties in native memory. In contrast to traditional struct patterns,
@@ -28,7 +28,7 @@
  */
 public abstract class Struct <T extends StructField> implements Savable {
 
-    private static final Map<Class, List<java.lang.reflect.Field>> structFieldCache = new HashMap<>();
+    protected static final Logger logger = Logger.getLogger(Struct.class.getName());
 
     private final List<T> fields = new LinkedList<>();
     protected StructLayout layout;
@@ -37,10 +37,26 @@ public abstract class Struct <T extends StructField> implements Savable {
     private int size, alignment;
 
     @Override
-    public void write(JmeExporter ex) throws IOException {}
+    public void write(JmeExporter ex) throws IOException {
+        if (layout != null) {
+            OutputCapsule out = ex.getCapsule(this);
+            out.write(layout.getIdentifier(), "layoutId", null);
+        }
+    }
 
     @Override
-    public void read(JmeImporter im) throws IOException {}
+    public void read(JmeImporter im) throws IOException {
+        InputCapsule in = im.getCapsule(this);
+        String layoutId = in.readString("layoutId", null);
+        if (layoutId != null) {
+            StructLayout l = StructLayout.getLayoutByIdentifier(layoutId);
+            if (l != null) {
+                bind(l);
+            } else {
+                logger.log(Level.WARNING, "Layout \"{0}\" is unknown. No layout assigned to struct.", layoutId);
+            }
+        }
+    }
 
     @SafeVarargs
     protected final void addFields(T... fields) {
@@ -54,6 +70,9 @@ public void bind(StructLayout layout, BufferMapping mapping, int position) {
     }
 
     public void bind(BufferMapping mapping, int position) {
+        if (layout == null) {
+            bind(StructLayout.packed);
+        }
         this.mapping = mapping;
         this.position = position;
     }
@@ -66,17 +85,32 @@ public void bind(Struct struct) {
      * Binds this struct with a layout defined by {@code layout}. If the layout
      * is changed, this struct is {@link #computeOffsets() recomputed}.
      *
-     * @param <E> struct type to return
      * @param layout layout
-     * @return this instance, as a builder convenience
      */
-    public <E extends Struct> E bind(StructLayout layout) {
+    public void bind(StructLayout layout) {
         if (this.layout == layout) {
-            return (E)this;
+            return;
         }
         this.layout = layout;
         computeOffsets();
-        return (E)this;
+    }
+
+    /**
+     * Reformats the currently bound buffer region according to the {@code layout},
+     * if this struct is not already bound to {@code layout}.
+     *
+     * @param layout new layout
+     */
+    public void reformat(StructLayout layout) {
+        if (this.layout != null && this.layout != layout) {
+            for (T f : fields) {
+                f.get(); // read to alias
+            }
+            bind(layout);
+            for (T f : fields) {
+                f.set(); // write from alias
+            }
+        }
     }
 
     /**
@@ -175,7 +209,7 @@ public Field(String name, T alias) {
         @Override
         public int bind(Struct struct, int offset) {
             this.struct = struct;
-            this.description = struct.getLayout().getFieldDescription(getType());
+            this.description = struct.getLayout().getFieldDescription(alias.getClass());
             return this.offset = FastMath.toMultipleOf(offset, getAlignment());
         }
 
@@ -196,21 +230,11 @@ public T alias() {
             return alias;
         }
 
-        @Override
-        public void setName(String name) {
-            this.name = name;
-        }
-
         @Override
         public String getName() {
             return name;
         }
 
-        @Override
-        public Class getType() {
-            return alias.getClass();
-        }
-
         @Override
         public int getSize() {
             assert description != null : "Struct not bound to a layout: size unknown.";

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

@@ -1,5 +1,7 @@
 package com.jme3.util.struct;
 
+import java.util.Objects;
+
 /**
  * Struct field member that serializes and deserializes values to native memory
  * relative to the bound struct's memory address.
@@ -40,29 +42,13 @@ public interface StructField <T> {
      */
     T alias();
 
-    /**
-     * Sets the name of this field. When created inside a {@link Struct}, the name will be
-     * assigned reflectively if no name is assigned manually.
-     *
-     * @param name field name
-     */
-    void setName(String name);
-
     /**
      * Gets the name of this field.
      *
      * @return name of this field
      */
     String getName();
 
-    /**
-     * Gets the object type represented by this field. This is used for selecting
-     * the field description to bind to this field.
-     *
-     * @return object type
-     */
-    Class getType();
-
     /**
      * Gets the size in bytes of this field. The managing struct
      * must be bound.
@@ -95,4 +81,13 @@ default String requireName() {
         return n;
     }
 
+    default boolean compareAndSet(T value) {
+        T current = get();
+        if (!Objects.equals(current, value)) {
+            set(value);
+            return true;
+        }
+        return false;
+    }
+
 }