rendering safety wrappers

FalsePattern · FalsePattern · commit 4f3e9ce5fcb0 · 2024-11-14T03:25:23.000+01:00
diff --git a/src/main/java/com/falsepattern/falsetweaks/config/FalseTweaksGuiConfig.java b/src/main/java/com/falsepattern/falsetweaks/config/FalseTweaksGuiConfig.java
@@ -77,6 +77,9 @@ private static List<IConfigElement> getConfigElements() throws ConfigException {
             result.add(category("occlusion", OcclusionConfig.class));
             result.add(category("threading", ThreadingConfig.class));
         }
+        if (ModuleConfig.RENDERING_SAFETY) {
+            result.add(category("rendering_safety", RenderingSafetyConfig.class));
+        }
         return result;
     }
 
diff --git a/src/main/java/com/falsepattern/falsetweaks/config/ModuleConfig.java b/src/main/java/com/falsepattern/falsetweaks/config/ModuleConfig.java
@@ -128,6 +128,11 @@ public class ModuleConfig {
     @Config.RequiresMcRestart
     public static boolean DYNAMIC_LIGHTS;
 
+    @Config.Comment("Wraps block renderer code and tile entity renderer code in extra opengl state guards.")
+    @Config.DefaultBoolean(true)
+    @Config.RequiresMcRestart
+    public static boolean RENDERING_SAFETY;
+
     @Config.Comment("Gets rid of that obnoxious burst of minecart sounds when joining a world.")
     @Config.DefaultBoolean(true)
     public static boolean MINECART_EAR_BLAST_FIX;
@@ -154,6 +159,7 @@ public class ModuleConfig {
         OcclusionConfig.init();
         ThreadingConfig.init();
         DynamicLightsConfig.init();
+        RenderingSafetyConfig.init();
     }
 
     public static boolean TRIANGULATOR() {
diff --git a/src/main/java/com/falsepattern/falsetweaks/config/RenderingSafetyConfig.java b/src/main/java/com/falsepattern/falsetweaks/config/RenderingSafetyConfig.java
@@ -0,0 +1,26 @@
+package com.falsepattern.falsetweaks.config;
+
+import com.falsepattern.falsetweaks.Tags;
+import com.falsepattern.lib.config.Config;
+import com.falsepattern.lib.config.ConfigurationManager;
+
+@Config(modid = Tags.MOD_ID,
+        category = "rendering_safety")
+public class RenderingSafetyConfig {
+    @Config.Comment("Enable safety wrapper for inventory blocks.")
+    @Config.LangKey("config.falsetweaks.rendering_safety.block")
+    @Config.DefaultBoolean(true)
+    public static boolean ENABLE_BLOCK;
+    @Config.Comment("Enable safety wrapper for tile entities.")
+    @Config.LangKey("config.falsetweaks.rendering_safety.tesr")
+    @Config.DefaultBoolean(true)
+    public static boolean ENABLE_TESR;
+
+    static {
+        ConfigurationManager.selfInit();
+    }
+
+    public static void init() {
+
+    }
+}
diff --git a/src/main/java/com/falsepattern/falsetweaks/mixin/mixins/client/rendersafety/RenderingRegistryMixin.java b/src/main/java/com/falsepattern/falsetweaks/mixin/mixins/client/rendersafety/RenderingRegistryMixin.java
@@ -0,0 +1,31 @@
+package com.falsepattern.falsetweaks.mixin.mixins.client.rendersafety;
+
+import com.falsepattern.falsetweaks.config.RenderingSafetyConfig;
+import com.llamalad7.mixinextras.injector.wrapoperation.Operation;
+import com.llamalad7.mixinextras.injector.wrapoperation.WrapOperation;
+import lombok.val;
+import org.lwjgl.opengl.GL11;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+
+import net.minecraft.block.Block;
+import net.minecraft.client.renderer.RenderBlocks;
+import cpw.mods.fml.client.registry.ISimpleBlockRenderingHandler;
+import cpw.mods.fml.client.registry.RenderingRegistry;
+
+@Mixin(value = RenderingRegistry.class,
+       remap = false)
+public abstract class RenderingRegistryMixin {
+    @WrapOperation(method = "renderInventoryBlock",
+                   at = @At(value = "INVOKE",
+                       target = "Lcpw/mods/fml/client/registry/ISimpleBlockRenderingHandler;renderInventoryBlock(Lnet/minecraft/block/Block;IILnet/minecraft/client/renderer/RenderBlocks;)V"),
+                   require = 1)
+    private void wrapBlock(ISimpleBlockRenderingHandler instance, Block block, int metadata, int modelID, RenderBlocks renderer, Operation<Void> original) {
+        val enable = RenderingSafetyConfig.ENABLE_BLOCK;
+        if (enable)
+            GL11.glPushAttrib(GL11.GL_ALL_ATTRIB_BITS);
+        original.call(instance, block, metadata, modelID, renderer);
+        if (enable)
+            GL11.glPopAttrib();
+    }
+}
diff --git a/src/main/java/com/falsepattern/falsetweaks/mixin/mixins/client/rendersafety/TileEntityRendererDispatcherMixin.java b/src/main/java/com/falsepattern/falsetweaks/mixin/mixins/client/rendersafety/TileEntityRendererDispatcherMixin.java
@@ -0,0 +1,29 @@
+package com.falsepattern.falsetweaks.mixin.mixins.client.rendersafety;
+
+import com.falsepattern.falsetweaks.config.RenderingSafetyConfig;
+import com.llamalad7.mixinextras.injector.wrapoperation.Operation;
+import com.llamalad7.mixinextras.injector.wrapoperation.WrapOperation;
+import lombok.val;
+import org.lwjgl.opengl.GL11;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+
+import net.minecraft.client.renderer.tileentity.TileEntityRendererDispatcher;
+import net.minecraft.client.renderer.tileentity.TileEntitySpecialRenderer;
+import net.minecraft.tileentity.TileEntity;
+
+@Mixin(TileEntityRendererDispatcher.class)
+public abstract class TileEntityRendererDispatcherMixin {
+    @WrapOperation(method = "renderTileEntityAt",
+                   at = @At(value = "INVOKE",
+                       target = "Lnet/minecraft/client/renderer/tileentity/TileEntitySpecialRenderer;renderTileEntityAt(Lnet/minecraft/tileentity/TileEntity;DDDF)V"),
+                   require = 1)
+    private void wrapTESR(TileEntitySpecialRenderer instance, TileEntity entity, double x, double y, double z, float tickDelta, Operation<Void> original) {
+        val enable = RenderingSafetyConfig.ENABLE_TESR;
+        if (enable)
+            GL11.glPushAttrib(GL11.GL_ALL_ATTRIB_BITS);
+        original.call(instance, entity, x, y, z, tickDelta);
+        if (enable)
+            GL11.glPopAttrib();
+    }
+}
diff --git a/src/main/java/com/falsepattern/falsetweaks/mixin/plugin/standard/Mixin.java b/src/main/java/com/falsepattern/falsetweaks/mixin/plugin/standard/Mixin.java
@@ -345,6 +345,10 @@ public enum Mixin implements IMixin {
     Debug_Occlusion_Neodymium_GPUMemoryManagerMixin(Side.CLIENT, THREADING.and(require(NEODYMIUM)).and(condition(() -> Debug.ENABLED)), "debug.occlusion.neodymium.GPUMemoryManagerMixin"),
     //endregion Debug
 
+    //region Render Safety
+    RenderingSafety_RenderingRegistryMixin(Side.CLIENT, condition(() -> ModuleConfig.RENDERING_SAFETY), "rendersafety.RenderingRegistryMixin"),
+    RenderingSafety_TileEntityRendererDispatcherMixin(Side.CLIENT, condition(() -> ModuleConfig.RENDERING_SAFETY), "rendersafety.TileEntityRendererDispatcherMixin"),
+
     ;
     // @formatter:on
 
diff --git a/src/main/resources/assets/falsetweaks/lang/en_US.lang b/src/main/resources/assets/falsetweaks/lang/en_US.lang
@@ -61,6 +61,11 @@ config.falsetweaks.threading.fastThreadedBlockBounds=Fast threaded block bounds
 config.falsetweaks.threading.fastSafety=Faster safety checks
 config.falsetweaks.threading.tessellatorReplaceEverything=Tessellator replace everything
 
+config.falsetweaks.rendering_safety.category=Rendering Safety
+config.falsetweaks.rendering_safety.category.tooltip=OpenGL state leakage fixes for inventory block renderers and tile entities
+config.falsetweaks.rendering_safety.block=Enable for inventory blocks
+config.falsetweaks.rendering_safety.tesr=Enable for tile entities
+
 gui.triangulator.calibrationdescription.line0=Click the Toggle button until the
 gui.triangulator.calibrationdescription.line1=yellow and the blue squares look the same,
 gui.triangulator.calibrationdescription.line2=then press the Apply button.
diff --git a/src/main/resources/assets/falsetweaks/lang/zh_CN.lang b/src/main/resources/assets/falsetweaks/lang/zh_CN.lang
@@ -62,6 +62,11 @@ config.falsetweaks.threading.logISBRHErrors=记录 ISimpleBlockRenderingHandler
 #TODO config.falsetweaks.threading.fastSafety=Faster safety checks
 #TODO config.falsetweaks.threading.tessellatorReplaceEverything=Tessellator replace everything
 
+#TODO config.falsetweaks.rendering_safety.category=Rendering Safety
+#TODO config.falsetweaks.rendering_safety.category.tooltip=OpenGL state leakage fixes for inventory block renderers and tile entities
+#TODO config.falsetweaks.rendering_safety.block=Enable for inventory blocks
+#TODO config.falsetweaks.rendering_safety.tesr=Enable for tile entities
+
 gui.triangulator.calibrationdescription.line0=点击切换按钮直到
 gui.triangulator.calibrationdescription.line1=黄色和蓝色方块看起来一样，
 gui.triangulator.calibrationdescription.line2=然后按应用按钮。

Original file line number	Diff line number	Diff line change
`@@ -77,6 +77,9 @@ private static List<IConfigElement> getConfigElements() throws ConfigException {`
`77`	`77`	`result.add(category("occlusion", OcclusionConfig.class));`
`78`	`78`	`result.add(category("threading", ThreadingConfig.class));`
`79`	`79`	`}`
	`80`	`+ if (ModuleConfig.RENDERING_SAFETY) {`
	`81`	`+ result.add(category("rendering_safety", RenderingSafetyConfig.class));`
	`82`	`+ }`
`80`	`83`	`return result;`
`81`	`84`	`}`
`82`	`85`
Original file line number	Diff line number	Diff line change
`@@ -345,6 +345,10 @@ public enum Mixin implements IMixin {`
`345`	`345`	`Debug_Occlusion_Neodymium_GPUMemoryManagerMixin(Side.CLIENT, THREADING.and(require(NEODYMIUM)).and(condition(() -> Debug.ENABLED)), "debug.occlusion.neodymium.GPUMemoryManagerMixin"),`
`346`	`346`	`//endregion Debug`
`347`	`347`
	`348`	`+ //region Render Safety`
	`349`	`+ RenderingSafety_RenderingRegistryMixin(Side.CLIENT, condition(() -> ModuleConfig.RENDERING_SAFETY), "rendersafety.RenderingRegistryMixin"),`
	`350`	`+ RenderingSafety_TileEntityRendererDispatcherMixin(Side.CLIENT, condition(() -> ModuleConfig.RENDERING_SAFETY), "rendersafety.TileEntityRendererDispatcherMixin"),`
	`351`	`+`
`348`	`352`	`;`
`349`	`353`	`// @formatter:on`
`350`	`354`