state leak safety for item renderers

Author: FalsePattern

src/main/java/com/falsepattern/falsetweaks/config/RenderingSafetyConfig.java

@@ -15,6 +15,10 @@ public class RenderingSafetyConfig {
     @Config.LangKey("config.falsetweaks.rendering_safety.tesr")
     @Config.DefaultBoolean(true)
     public static boolean ENABLE_TESR;
+    @Config.Comment("Enable safety wrapper for items.")
+    @Config.LangKey("config.falsetweaks.rendering_safety.item")
+    @Config.DefaultBoolean(true)
+    public static boolean ENABLE_ITEM;
 
     static {
         ConfigurationManager.selfInit();

src/main/java/com/falsepattern/falsetweaks/mixin/mixins/client/rendersafety/ForgeHooksClientMixin.java

@@ -0,0 +1,29 @@
+package com.falsepattern.falsetweaks.mixin.mixins.client.rendersafety;
+
+import com.falsepattern.falsetweaks.config.RenderingSafetyConfig;
+import com.falsepattern.falsetweaks.modules.rendersafety.SafetyUtil;
+import com.llamalad7.mixinextras.injector.wrapoperation.Operation;
+import com.llamalad7.mixinextras.injector.wrapoperation.WrapOperation;
+import lombok.val;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+
+import net.minecraft.item.ItemStack;
+import net.minecraftforge.client.ForgeHooksClient;
+import net.minecraftforge.client.IItemRenderer;
+
+@Mixin(value = ForgeHooksClient.class,
+       remap = false)
+public abstract class ForgeHooksClientMixin {
+    @WrapOperation(method = {"renderEntityItem", "renderInventoryItem", "renderEquippedItem"},
+                   at = @At(value = "INVOKE",
+                            target = "Lnet/minecraftforge/client/IItemRenderer;renderItem(Lnet/minecraftforge/client/IItemRenderer$ItemRenderType;Lnet/minecraft/item/ItemStack;[Ljava/lang/Object;)V"),
+                   require = 0, // Weak mixin to avoid crashes
+                   expect = 6)
+    private static void wrapRenderItem(IItemRenderer instance, IItemRenderer.ItemRenderType itemRenderType, ItemStack itemStack, Object[] objects, Operation<Void> original) {
+        val enable = RenderingSafetyConfig.ENABLE_ITEM;
+        SafetyUtil.pre(enable);
+        original.call(instance, itemRenderType, itemStack, objects);
+        SafetyUtil.post(enable);
+    }
+}

src/main/java/com/falsepattern/falsetweaks/mixin/mixins/client/rendersafety/ItemRendererMixin.java

@@ -0,0 +1,28 @@
+package com.falsepattern.falsetweaks.mixin.mixins.client.rendersafety;
+
+import com.falsepattern.falsetweaks.config.RenderingSafetyConfig;
+import com.falsepattern.falsetweaks.modules.rendersafety.SafetyUtil;
+import com.llamalad7.mixinextras.injector.wrapoperation.Operation;
+import com.llamalad7.mixinextras.injector.wrapoperation.WrapOperation;
+import lombok.val;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+
+import net.minecraft.client.renderer.ItemRenderer;
+import net.minecraft.item.ItemStack;
+import net.minecraftforge.client.IItemRenderer;
+
+@Mixin(ItemRenderer.class)
+public abstract class ItemRendererMixin {
+    @WrapOperation(method = "renderItemInFirstPerson",
+                   at = @At(value = "INVOKE",
+                            target = "Lnet/minecraftforge/client/IItemRenderer;renderItem(Lnet/minecraftforge/client/IItemRenderer$ItemRenderType;Lnet/minecraft/item/ItemStack;[Ljava/lang/Object;)V"),
+                   require = 0,
+                   expect = 1)
+    private void wrapRenderItem(IItemRenderer instance, IItemRenderer.ItemRenderType itemRenderType, ItemStack itemStack, Object[] objects, Operation<Void> original) {
+        val enable = RenderingSafetyConfig.ENABLE_ITEM;
+        SafetyUtil.pre(enable);
+        original.call(instance, itemRenderType, itemStack, objects);
+        SafetyUtil.post(enable);
+    }
+}

src/main/java/com/falsepattern/falsetweaks/mixin/mixins/client/rendersafety/RenderingRegistryMixin.java

@@ -1,6 +1,7 @@
 package com.falsepattern.falsetweaks.mixin.mixins.client.rendersafety;
 
 import com.falsepattern.falsetweaks.config.RenderingSafetyConfig;
+import com.falsepattern.falsetweaks.modules.rendersafety.SafetyUtil;
 import com.llamalad7.mixinextras.injector.wrapoperation.Operation;
 import com.llamalad7.mixinextras.injector.wrapoperation.WrapOperation;
 import lombok.val;
@@ -9,6 +10,7 @@
 import org.spongepowered.asm.mixin.injection.At;
 
 import net.minecraft.block.Block;
+import net.minecraft.client.renderer.OpenGlHelper;
 import net.minecraft.client.renderer.RenderBlocks;
 import cpw.mods.fml.client.registry.ISimpleBlockRenderingHandler;
 import cpw.mods.fml.client.registry.RenderingRegistry;
@@ -22,10 +24,8 @@ public abstract class RenderingRegistryMixin {
                    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);
+        SafetyUtil.pre(enable);
         original.call(instance, block, metadata, modelID, renderer);
-        if (enable)
-            GL11.glPopAttrib();
+        SafetyUtil.post(enable);
     }
 }

src/main/java/com/falsepattern/falsetweaks/mixin/mixins/client/rendersafety/TileEntityRendererDispatcherMixin.java

@@ -1,13 +1,15 @@
 package com.falsepattern.falsetweaks.mixin.mixins.client.rendersafety;
 
 import com.falsepattern.falsetweaks.config.RenderingSafetyConfig;
+import com.falsepattern.falsetweaks.modules.rendersafety.SafetyUtil;
 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.OpenGlHelper;
 import net.minecraft.client.renderer.tileentity.TileEntityRendererDispatcher;
 import net.minecraft.client.renderer.tileentity.TileEntitySpecialRenderer;
 import net.minecraft.tileentity.TileEntity;
@@ -20,10 +22,8 @@ public abstract class TileEntityRendererDispatcherMixin {
                    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);
+        SafetyUtil.pre(enable);
         original.call(instance, entity, x, y, z, tickDelta);
-        if (enable)
-            GL11.glPopAttrib();
+        SafetyUtil.post(enable);
     }
 }

src/main/java/com/falsepattern/falsetweaks/mixin/plugin/standard/Mixin.java

@@ -343,6 +343,8 @@ public enum Mixin implements IMixin {
     //endregion Debug
 
     //region Render Safety
+    RenderingSafety_ForgeHooksClientMixin(Side.CLIENT, condition(() -> ModuleConfig.RENDERING_SAFETY), "rendersafety.ForgeHooksClientMixin"),
+    RenderingSafety_ItemRendererMixin(Side.CLIENT, condition(() -> ModuleConfig.RENDERING_SAFETY), "rendersafety.ItemRendererMixin"),
     RenderingSafety_RenderingRegistryMixin(Side.CLIENT, condition(() -> ModuleConfig.RENDERING_SAFETY), "rendersafety.RenderingRegistryMixin"),
     RenderingSafety_TileEntityRendererDispatcherMixin(Side.CLIENT, condition(() -> ModuleConfig.RENDERING_SAFETY).and(avoid(TargetedMod.DRAGONAPI)), "rendersafety.TileEntityRendererDispatcherMixin"),
     RenderingSafety_DragonAPI_TileEntityRenderEventMixin(Side.CLIENT, condition(() -> ModuleConfig.RENDERING_SAFETY).and(require(TargetedMod.DRAGONAPI)), "rendersafety.dragonapi.TileEntityRenderEventMixin"),

src/main/java/com/falsepattern/falsetweaks/modules/rendersafety/SafetyUtil.java

@@ -0,0 +1,20 @@
+package com.falsepattern.falsetweaks.modules.rendersafety;
+
+import org.lwjgl.opengl.GL11;
+
+import net.minecraft.client.renderer.OpenGlHelper;
+
+public class SafetyUtil {
+    public static void pre(boolean enable) {
+        if (enable) {
+            GL11.glPushAttrib(GL11.GL_ALL_ATTRIB_BITS);
+        }
+    }
+
+    public static void post(boolean enable) {
+        if (enable) {
+            OpenGlHelper.setLightmapTextureCoords(OpenGlHelper.lightmapTexUnit, 240, 240);
+            GL11.glPopAttrib();
+        }
+    }
+}

src/main/resources/assets/falsetweaks/lang/en_US.lang

@@ -65,6 +65,7 @@ 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
+config.falsetweaks.rendering_safety.item=Enable for items
 
 gui.triangulator.calibrationdescription.line0=Click the Toggle button until the
 gui.triangulator.calibrationdescription.line1=yellow and the blue squares look the same,

src/main/resources/assets/falsetweaks/lang/zh_CN.lang

@@ -66,6 +66,7 @@ config.falsetweaks.threading.logISBRHErrors=记录 ISimpleBlockRenderingHandler
 #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
+#TODO config.falsetweaks.rendering_safety.item=Enable for items
 
 gui.triangulator.calibrationdescription.line0=点击切换按钮直到
 gui.triangulator.calibrationdescription.line1=黄色和蓝色方块看起来一样，