Migrate all shaders to global uniforms

KitsuneAlex · KitsuneAlex · commit 3e777f2bc2a9 · 2024-08-28T23:50:20.000+02:00
diff --git a/src/api/java/io/karma/pda/api/client/render/shader/uniform/UniformBuffer.java b/src/api/java/io/karma/pda/api/client/render/shader/uniform/UniformBuffer.java
@@ -16,7 +16,7 @@
 public interface UniformBuffer {
     int getId();
 
-    int getBindingPoint();
+    int getBufferId();
 
     UniformCache getCache();
 
diff --git a/src/foundation/java/io/karma/pda/foundation/client/render/ComponentRenderTypes.java b/src/foundation/java/io/karma/pda/foundation/client/render/ComponentRenderTypes.java
@@ -28,26 +28,13 @@
 @OnlyIn(Dist.CLIENT)
 public final class ComponentRenderTypes {
     // @formatter:off
-    private static final ShaderProgram SPINNER_SHADER = ClientAPI.getShaderHandler().create(builder -> builder
-        .shader(object -> object
-            .type(ShaderType.VERTEX)
-            .location(Constants.MODID, "shaders/spinner.vert.glsl")
-            .defaultPreProcessor()
-        )
-        .shader(object -> object
-            .type(ShaderType.FRAGMENT)
-            .location(Constants.MODID, "shaders/spinner.frag.glsl")
-            .defaultPreProcessor()
-        )
-        .defaultUniforms()
-        .uniformTime()
-    );
+    private static ShaderProgram spinnerShader;
     public static final Function<DisplayMode, RenderType> SPINNER = Util.memoize(displayMode ->
         RenderType.create(String.format("pda_display_spinner__%s", displayMode),
             DefaultVertexFormat.POSITION_TEX_COLOR, VertexFormat.Mode.TRIANGLES, 256, false, false,
             RenderType.CompositeState.builder()
                 .setCullState(RenderStateShard.NO_CULL)
-                .setShaderState(SPINNER_SHADER.asStateShard())
+                .setShaderState(spinnerShader.asStateShard())
                 .setOutputState(displayMode.getOutputState())
                 .setTransparencyState(RenderStateShard.TRANSLUCENT_TRANSPARENCY)
                 .setLayeringState(RenderStateShard.POLYGON_OFFSET_LAYERING)
@@ -60,5 +47,20 @@ private ComponentRenderTypes() {
 
     @Internal
     public static void createShaders() {
+        // @formatter:off
+        spinnerShader = ClientAPI.getShaderHandler().create(builder -> builder
+            .shader(object -> object
+                .type(ShaderType.VERTEX)
+                .location(Constants.MODID, "shaders/spinner.vert.glsl")
+                .defaultPreProcessor()
+            )
+            .shader(object -> object
+                .type(ShaderType.FRAGMENT)
+                .location(Constants.MODID, "shaders/spinner.frag.glsl")
+                .defaultPreProcessor()
+            )
+            .globalUniforms()
+        );
+        // @formatter:on
     }
 }
diff --git a/src/main/java/io/karma/pda/mod/client/render/graphics/GraphicsRenderTypes.java b/src/main/java/io/karma/pda/mod/client/render/graphics/GraphicsRenderTypes.java
@@ -77,7 +77,7 @@ public static void createShaders() { // @formatter:off
                 .location(Constants.MODID, "shaders/display_color.frag.glsl")
                 .defaultPreProcessor()
             )
-            .defaultUniforms()
+            .globalUniforms()
         );
         colorTexShader = DefaultShaderHandler.INSTANCE.create(builder -> builder
             .shader(object -> object
@@ -91,7 +91,7 @@ public static void createShaders() { // @formatter:off
                 .defaultPreProcessor()
             )
             .sampler("Sampler0")
-            .defaultUniforms()
+            .globalUniforms()
         );
     } // @formatter:on
 
diff --git a/src/main/java/io/karma/pda/mod/client/render/shader/DefaultUniformBuffer.java b/src/main/java/io/karma/pda/mod/client/render/shader/DefaultUniformBuffer.java
@@ -9,7 +9,6 @@
 import io.karma.pda.api.client.render.shader.uniform.UniformBuffer;
 import io.karma.pda.api.client.render.shader.uniform.UniformCache;
 import io.karma.pda.api.dispose.Disposable;
-import io.karma.pda.api.util.HashUtils;
 import io.karma.pda.api.util.LogMarkers;
 import io.karma.pda.mod.PDAMod;
 import it.unimi.dsi.fastutil.objects.Object2IntOpenHashMap;
@@ -30,18 +29,17 @@ public final class DefaultUniformBuffer implements UniformBuffer, Disposable {
     private final BiConsumer<ShaderProgram, UniformBuffer> bindCallback;
     private final BiConsumer<ShaderProgram, UniformBuffer> unbindCallback;
     private final int size;
-    private final int bindingPoint;
     private final Object2IntOpenHashMap<String> fieldOffsets = new Object2IntOpenHashMap<>();
-    private int id = -1;
+    private final int id;
+    private int bufferId = -1;
 
     public DefaultUniformBuffer(final LinkedHashMap<String, Uniform> uniforms,
                                 final BiConsumer<ShaderProgram, UniformBuffer> bindCallback,
                                 final BiConsumer<ShaderProgram, UniformBuffer> unbindCallback,
-                                final int bindingPoint) {
+                                final int id) {
         this.bindCallback = bindCallback;
         this.unbindCallback = unbindCallback;
-        this.bindingPoint = bindingPoint;
-
+        this.id = id;
         cache = new DefaultUniformCache(uniforms);
         size = cache.getAll().values().stream().mapToInt(u -> u.getType().getAlignedSize()).sum();
 
@@ -61,26 +59,29 @@ public int getId() {
     }
 
     @Override
-    public int getBindingPoint() {
-        return bindingPoint;
+    public int getBufferId() {
+        return bufferId;
     }
 
     @Override
     public void setup(final String name, final ShaderProgram program) {
-        if (id == -1) {
-            id = GL15.glGenBuffers();
-            GL15.glBindBuffer(GL33.GL_UNIFORM_BUFFER, id);
+        if (bufferId == -1) {
+            bufferId = GL15.glGenBuffers();
+            GL15.glBindBuffer(GL33.GL_UNIFORM_BUFFER, bufferId);
             GL15.glBufferData(GL33.GL_UNIFORM_BUFFER, size, GL20.GL_STATIC_DRAW);
             GL15.glBindBuffer(GL33.GL_UNIFORM_BUFFER, 0);
-            PDAMod.LOGGER.debug(LogMarkers.RENDERER, "Created new uniform buffer object {} with {} bytes", id, size);
+            PDAMod.LOGGER.debug(LogMarkers.RENDERER,
+                "Created new uniform buffer object {} with {} bytes",
+                bufferId,
+                size);
         }
         final var blockIndex = program.getUniformBlockIndex(name);
-        GL31.glUniformBlockBinding(program.getId(), blockIndex, bindingPoint);
+        GL31.glUniformBlockBinding(program.getId(), blockIndex, id);
         PDAMod.LOGGER.debug(LogMarkers.RENDERER,
             "Associated uniform block index {} with binding point {}",
             blockIndex,
-            bindingPoint);
-        GL30.glBindBufferBase(GL33.GL_UNIFORM_BUFFER, bindingPoint, id);
+            id);
+        GL30.glBindBufferBase(GL33.GL_UNIFORM_BUFFER, id, bufferId);
     }
 
     @Override
@@ -111,16 +112,16 @@ public int getFieldOffset(final String name) {
 
     @Override
     public void dispose() {
-        GL15.glDeleteBuffers(id);
+        GL15.glDeleteBuffers(bufferId);
     }
 
     @Override
     public int hashCode() {
-        return HashUtils.combine(bindingPoint, cache.hashCode());
+        return cache.hashCode();
     }
 
     @Override
     public String toString() {
-        return String.format("DefaultUniformBuffer[id=%d,size=%d]", id, size);
+        return String.format("DefaultUniformBuffer[id=%d,size=%d]", bufferId, size);
     }
 }
diff --git a/src/main/java/io/karma/pda/mod/client/render/shader/DefaultUniformBufferBuilder.java b/src/main/java/io/karma/pda/mod/client/render/shader/DefaultUniformBufferBuilder.java
@@ -23,7 +23,7 @@
 public final class DefaultUniformBufferBuilder implements UniformBufferBuilder {
     private static final BiConsumer<ShaderProgram, UniformBuffer> IDENTITY_CALLBACK = (s, b) -> {
     };
-    private static int nextBindingPoint;
+    private static int nextGlobalIndex;
 
     private final LinkedHashMap<String, Uniform> uniforms = new LinkedHashMap<>();
     private BiConsumer<ShaderProgram, UniformBuffer> bindCallback = IDENTITY_CALLBACK;
@@ -59,6 +59,6 @@ public UniformBufferBuilder onUnbind(final BiConsumer<ShaderProgram, UniformBuff
     }
 
     public DefaultUniformBuffer build() {
-        return new DefaultUniformBuffer(uniforms, bindCallback, unbindCallback, nextBindingPoint++);
+        return new DefaultUniformBuffer(uniforms, bindCallback, unbindCallback, nextGlobalIndex++);
     }
 }
diff --git a/src/main/java/io/karma/pda/mod/client/render/shader/DefaultUniformCache.java b/src/main/java/io/karma/pda/mod/client/render/shader/DefaultUniformCache.java
@@ -11,7 +11,6 @@
 import io.karma.pda.api.util.HashUtils;
 import net.minecraftforge.api.distmarker.Dist;
 import net.minecraftforge.api.distmarker.OnlyIn;
-import org.jetbrains.annotations.ApiStatus.Internal;
 import org.lwjgl.opengl.GL15;
 import org.lwjgl.opengl.GL33;
 
@@ -31,11 +30,6 @@ public final class DefaultUniformCache implements UniformCache {
         this.uniforms = uniforms;
     }
 
-    @Internal
-    public void merge(final UniformCache cache) {
-        uniforms.putAll(cache.getAll());
-    }
-
     @Override
     public Map<String, Uniform> getAll() {
         return uniforms;
@@ -51,20 +45,8 @@ public void applyAll(final ShaderProgram program) {
     @Override
     public void uploadAll(final UniformBuffer buffer) {
         final var uniforms = this.uniforms.values();
-        // Find out if mapping the memory is worth it and return if we don't have any updates
-        var needsRemap = false;
-        for (final var uniform : uniforms) {
-            if (!uniform.requiresUpdate()) {
-                continue;
-            }
-            needsRemap = true;
-            break;
-        }
-        if (!needsRemap) {
-            return;
-        }
         // Map UBO into memory so we can memcpy into it directly
-        GL15.glBindBuffer(GL33.GL_UNIFORM_BUFFER, buffer.getId());
+        GL15.glBindBuffer(GL33.GL_UNIFORM_BUFFER, buffer.getBufferId());
         final var address = GL15.nglMapBuffer(GL33.GL_UNIFORM_BUFFER, GL15.GL_WRITE_ONLY);
         for (final var uniform : uniforms) {
             uniform.upload(buffer, address);
diff --git a/src/main/resources/assets/pda/shaders/display_color.frag.glsl b/src/main/resources/assets/pda/shaders/display_color.frag.glsl
@@ -4,9 +4,9 @@
  * Copyright (C) 2024 Karma Krafts & associates
  */
 
-in vec4 vertexColor;
+#include "include/global_uniforms.glsl"
 
-uniform vec4 ColorModulator;
+in vec4 vertexColor;
 
 out vec4 fragColor;
 
diff --git a/src/main/resources/assets/pda/shaders/display_color.vert.glsl b/src/main/resources/assets/pda/shaders/display_color.vert.glsl
@@ -4,12 +4,11 @@
  * Copyright (C) 2024 Karma Krafts & associates
  */
 
+#include "include/global_uniforms.glsl"
+
 in vec3 Position;
 in vec4 Color;
 
-uniform mat4 ModelViewMat;
-uniform mat4 ProjMat;
-
 out vec4 vertexColor;
 
 void main() {
diff --git a/src/main/resources/assets/pda/shaders/display_color_tex.frag.glsl b/src/main/resources/assets/pda/shaders/display_color_tex.frag.glsl
@@ -4,9 +4,9 @@
  * Copyright (C) 2024 Karma Krafts & associates
  */
 
-uniform sampler2D Sampler0;
+#include "include/global_uniforms.glsl"
 
-uniform vec4 ColorModulator;
+uniform sampler2D Sampler0;
 
 in vec4 vertexColor;
 in vec2 texCoord0;
diff --git a/src/main/resources/assets/pda/shaders/display_color_tex.vert.glsl b/src/main/resources/assets/pda/shaders/display_color_tex.vert.glsl
@@ -4,13 +4,12 @@
  * Copyright (C) 2024 Karma Krafts & associates
  */
 
+#include "include/global_uniforms.glsl"
+
 in vec3 Position;
 in vec4 Color;
 in vec2 UV0;
 
-uniform mat4 ModelViewMat;
-uniform mat4 ProjMat;
-
 out vec4 vertexColor;
 out vec2 texCoord0;
 
diff --git a/src/main/resources/assets/pda/shaders/spinner.frag.glsl b/src/main/resources/assets/pda/shaders/spinner.frag.glsl
@@ -5,11 +5,11 @@
  * Source: https://www.shadertoy.com/view/Mc3Xzf
  */
 
+#include "include/global_uniforms.glsl"
+
 in vec4 vertexColor;
 in vec2 texCoord0;
 
-uniform float Time;
-
 out vec4 fragColor;
 
 const float PI = 3.14159265359;
diff --git a/src/main/resources/assets/pda/shaders/spinner.vert.glsl b/src/main/resources/assets/pda/shaders/spinner.vert.glsl
@@ -4,13 +4,12 @@
  * Copyright (C) 2024 Karma Krafts & associates
  */
 
+#include "include/global_uniforms.glsl"
+
 in vec3 Position;
 in vec2 UV0;
 in vec4 Color;
 
-uniform mat4 ModelViewMat;
-uniform mat4 ProjMat;
-
 out vec4 vertexColor;
 out vec2 texCoord0;
 

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`public final class DefaultUniformBufferBuilder implements UniformBufferBuilder {`
`24`	`24`	`private static final BiConsumer<ShaderProgram, UniformBuffer> IDENTITY_CALLBACK = (s, b) -> {`
`25`	`25`	`};`
`26`		`- private static int nextBindingPoint;`
	`26`	`+ private static int nextGlobalIndex;`
`27`	`27`
`28`	`28`	`private final LinkedHashMap<String, Uniform> uniforms = new LinkedHashMap<>();`
`29`	`29`	`private BiConsumer<ShaderProgram, UniformBuffer> bindCallback = IDENTITY_CALLBACK;`
`@@ -59,6 +59,6 @@ public UniformBufferBuilder onUnbind(final BiConsumer<ShaderProgram, UniformBuff`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`public DefaultUniformBuffer build() {`
`62`		`- return new DefaultUniformBuffer(uniforms, bindCallback, unbindCallback, nextBindingPoint++);`
	`62`	`+ return new DefaultUniformBuffer(uniforms, bindCallback, unbindCallback, nextGlobalIndex++);`
`63`	`63`	`}`
`64`	`64`	`}`