From ec7a098f81579abf11c903bf412311a28e2778a1 Mon Sep 17 00:00:00 2001 From: Matt Date: Sun, 24 Aug 2025 01:09:12 -0400 Subject: [PATCH] Add event for adding framepasses (#10612) --- .../client/renderer/LevelRenderer.java.patch | 16 +++ .../client/ForgeHooksClient.java | 4 + .../client/FramePassManager.java | 44 ++++++++ .../client/event/AddFramePassEvent.java | 34 +++++++ .../client/event/ForgeEventFactoryClient.java | 5 + .../generated/closed_module/module-info.dat | Bin 555 -> 555 bytes .../frame_passes_run.json | 7 ++ .../debug/client/RenderFrameLayerTest.java | 94 ++++++++++++++++++ .../META-INF/mods.toml | 1 + 9 files changed, 205 insertions(+) create mode 100644 src/main/java/net/minecraftforge/client/FramePassManager.java create mode 100644 src/main/java/net/minecraftforge/client/event/AddFramePassEvent.java create mode 100644 src/test/generated/render_frame_layer_test/data/forge/test_instance/render_frame_layer_test/frame_passes_run.json create mode 100644 src/test/java/net/minecraftforge/debug/client/RenderFrameLayerTest.java create mode 100644 src/test/resources/render_frame_layer_test/META-INF/mods.toml diff --git a/patches/minecraft/net/minecraft/client/renderer/LevelRenderer.java.patch b/patches/minecraft/net/minecraft/client/renderer/LevelRenderer.java.patch index f75ac4e2be..7dc9a5d23c 100644 --- a/patches/minecraft/net/minecraft/client/renderer/LevelRenderer.java.patch +++ b/patches/minecraft/net/minecraft/client/renderer/LevelRenderer.java.patch @@ -9,6 +9,14 @@ @Nullable private ClientLevel level; private final SectionOcclusionGraph sectionOcclusionGraph = new SectionOcclusionGraph(); +@@ -161,6 +_,7 @@ + this.entityRenderDispatcher = p_234246_; + this.blockEntityRenderDispatcher = p_234247_; + this.renderBuffers = p_234248_; ++ net.minecraftforge.client.event.ForgeEventFactoryClient.onInitLevelRenderer(); + } + + public void tickParticles(Camera p_369538_) { @@ -480,7 +_,7 @@ postchain1.addToFrame(framegraphbuilder, i, j, this.targets); } @@ -18,6 +26,14 @@ CloudStatus cloudstatus = this.minecraft.options.getCloudsType(); if (cloudstatus != CloudStatus.OFF) { Optional optional = this.level.dimensionType().cloudHeight(); +@@ -497,6 +_,7 @@ + } + + this.addLateDebugPass(framegraphbuilder, vec3, p_407881_); ++ net.minecraftforge.client.FramePassManager.insertForgePasses(framegraphbuilder, targets); // Forge: Modded passes are inserted here. + profilerfiller.popPush("framegraph"); + framegraphbuilder.execute(p_367325_, new FrameGraphBuilder.Inspector() { + @Override @@ -577,7 +_,7 @@ multibuffersource$buffersource.endLastBatch(); this.checkPoseStack(posestack); diff --git a/src/main/java/net/minecraftforge/client/ForgeHooksClient.java b/src/main/java/net/minecraftforge/client/ForgeHooksClient.java index ad8ed37dd6..b1edb60f67 100644 --- a/src/main/java/net/minecraftforge/client/ForgeHooksClient.java +++ b/src/main/java/net/minecraftforge/client/ForgeHooksClient.java @@ -884,4 +884,8 @@ public class ForgeHooksClient { return parent.compute(p_395456_); } } + + public static void addFramePass(ResourceLocation rl, FramePassManager.PassDefinition definition) { + FramePassManager.addPass(rl, definition); + } } diff --git a/src/main/java/net/minecraftforge/client/FramePassManager.java b/src/main/java/net/minecraftforge/client/FramePassManager.java new file mode 100644 index 0000000000..37188003dc --- /dev/null +++ b/src/main/java/net/minecraftforge/client/FramePassManager.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) Forge Development LLC and contributors + * SPDX-License-Identifier: LGPL-2.1-only + */ +package net.minecraftforge.client; + +import com.mojang.blaze3d.framegraph.FrameGraphBuilder; +import com.mojang.blaze3d.framegraph.FramePass; +import net.minecraft.client.renderer.LevelTargetBundle; +import net.minecraft.resources.ResourceLocation; +import org.jetbrains.annotations.ApiStatus; + +import java.util.ArrayList; +import java.util.List; + +public class FramePassManager { + private static final List addedPasses = new ArrayList<>(); + + protected static void addPass(ResourceLocation name, PassDefinition pass) { + if (addedPasses.stream().noneMatch(info -> info.name.equals(name.toString()))) { + addedPasses.add(new PassInfo(name.toString(), pass)); + } else { + throw new IllegalArgumentException("Cannot create a frame pass with a duplicate name: " + name); + } + } + + // Note: Pass order is determined automatically within FrameGraphBuilder. It's unclear what must be done to guarantee ordering. + @ApiStatus.Internal + public static void insertForgePasses(FrameGraphBuilder graphBuilder, LevelTargetBundle bundle) { + for (PassInfo info : addedPasses) { + FramePass pass = graphBuilder.addPass(info.name); + PassDefinition forgePass = info.pass; + forgePass.targets(bundle, pass); + pass.executes(forgePass::executes); + } + } + + public interface PassDefinition { + void targets(LevelTargetBundle bundle, FramePass pass); + void executes(); + } + + private record PassInfo(String name, PassDefinition pass){} +} diff --git a/src/main/java/net/minecraftforge/client/event/AddFramePassEvent.java b/src/main/java/net/minecraftforge/client/event/AddFramePassEvent.java new file mode 100644 index 0000000000..5749771334 --- /dev/null +++ b/src/main/java/net/minecraftforge/client/event/AddFramePassEvent.java @@ -0,0 +1,34 @@ +/* + * Copyright (c) Forge Development LLC and contributors + * SPDX-License-Identifier: LGPL-2.1-only + */ +package net.minecraftforge.client.event; + +import net.minecraft.resources.ResourceLocation; +import net.minecraftforge.client.ForgeHooksClient; +import net.minecraftforge.client.FramePassManager; +import net.minecraftforge.eventbus.api.bus.EventBus; +import net.minecraftforge.eventbus.api.event.RecordEvent; +import org.jspecify.annotations.NullMarked; + +/** + * Fired after all vanilla frame passes are added into the pass list. + * + *

This event is fired on the {@linkplain net.minecraftforge.common.MinecraftForge#EVENT_BUS main Forge event bus}, + * only on the {@linkplain net.minecraftforge.fml.LogicalSide#CLIENT logical client}. + */ +@NullMarked +public record AddFramePassEvent() implements RecordEvent { + public static final EventBus BUS = EventBus.create(AddFramePassEvent.class); + /** + * Adds a frame pass to pass list. + * Create a new {@linkplain FramePassManager.PassDefinition} to handle render targets and render code. + * + * @param rl Resource location for frame pass name. Use RLs to avoid duplicate names. + * @param definition see usages of {@linkplain com.mojang.blaze3d.framegraph.FramePass} in {@linkplain net.minecraft.client.renderer.LevelRenderer} + * @throws IllegalArgumentException If the name is a duplicate. + */ + public void addPass(ResourceLocation rl, FramePassManager.PassDefinition definition) { + ForgeHooksClient.addFramePass(rl, definition); + } +} \ No newline at end of file diff --git a/src/main/java/net/minecraftforge/client/event/ForgeEventFactoryClient.java b/src/main/java/net/minecraftforge/client/event/ForgeEventFactoryClient.java index 6b8a5764d4..dd0461020a 100644 --- a/src/main/java/net/minecraftforge/client/event/ForgeEventFactoryClient.java +++ b/src/main/java/net/minecraftforge/client/event/ForgeEventFactoryClient.java @@ -10,6 +10,7 @@ import java.util.List; import java.util.Map; import java.util.function.Function; +import net.minecraftforge.client.FramePassManager; import net.minecraftforge.client.gui.overlay.ForgeLayeredDraw; import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.common.util.Result; @@ -285,6 +286,10 @@ public final class ForgeEventFactoryClient { return fireModBus(new ModelEvent.RegisterModelStateDefinitions()); } + public static void onInitLevelRenderer() { + AddFramePassEvent.BUS.post(new AddFramePassEvent()); + } + public static void onComputeLayerOrder(ForgeLayeredDraw layeredDraw) { fireModBus(new AddGuiOverlayLayersEvent(layeredDraw)); } diff --git a/src/test/generated/closed_module/module-info.dat b/src/test/generated/closed_module/module-info.dat index dbb5f663cda2bcfc2432495edf9bc90e63e41b95..27639b2fc4ca4e39997a599ebac4b6ef7ef88114 100644 GIT binary patch delta 19 acmZ3@vYKTB7ZbY}gAjuVgTQ1#CMf_Y{sS%m delta 19 acmZ3@vYKTB7ZbYxgBXJlgUDn-CMf_Y<^wJO diff --git a/src/test/generated/render_frame_layer_test/data/forge/test_instance/render_frame_layer_test/frame_passes_run.json b/src/test/generated/render_frame_layer_test/data/forge/test_instance/render_frame_layer_test/frame_passes_run.json new file mode 100644 index 0000000000..60a9022c97 --- /dev/null +++ b/src/test/generated/render_frame_layer_test/data/forge/test_instance/render_frame_layer_test/frame_passes_run.json @@ -0,0 +1,7 @@ +{ + "type": "minecraft:function", + "environment": "minecraft:default", + "function": "forge:render_frame_layer_test/frame_passes_run", + "max_ticks": 100, + "structure": "forge:empty3x3x3" +} \ No newline at end of file diff --git a/src/test/java/net/minecraftforge/debug/client/RenderFrameLayerTest.java b/src/test/java/net/minecraftforge/debug/client/RenderFrameLayerTest.java new file mode 100644 index 0000000000..f2af636133 --- /dev/null +++ b/src/test/java/net/minecraftforge/debug/client/RenderFrameLayerTest.java @@ -0,0 +1,94 @@ +/* + * Copyright (c) Forge Development LLC and contributors + * SPDX-License-Identifier: LGPL-2.1-only + */ +package net.minecraftforge.debug.client; + +import net.minecraft.client.renderer.LevelTargetBundle; +import net.minecraftforge.client.FramePassManager; +import net.minecraftforge.client.event.AddFramePassEvent; +import net.minecraftforge.common.extensions.IForgeGameTestHelper; +import net.minecraftforge.eventbus.api.listener.SubscribeEvent; +import net.minecraftforge.fml.common.Mod; +import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext; +import net.minecraftforge.gametest.GameTest; +import net.minecraftforge.gametest.GameTestNamespace; +import net.minecraftforge.test.BaseTestMod; +import net.minecraft.client.Minecraft; +import net.minecraft.client.renderer.RenderType; +import net.minecraft.client.renderer.ShapeRenderer; +import net.minecraft.gametest.framework.GameTestHelper; +import com.mojang.blaze3d.vertex.PoseStack; +import com.mojang.blaze3d.framegraph.FramePass; + + +@GameTestNamespace("forge") +@Mod(RenderFrameLayerTest.MODID) +public class RenderFrameLayerTest extends BaseTestMod { + public static final String MODID = "render_frame_layer_test"; + private static final IForgeGameTestHelper.BoolFlag passOne = new IForgeGameTestHelper.BoolFlag("pass_one_flag"); + private static final IForgeGameTestHelper.BoolFlag passTwo = new IForgeGameTestHelper.BoolFlag("pass_two_flag"); + public RenderFrameLayerTest(FMLJavaModLoadingContext context) { + super(context, false, false); + AddFramePassEvent.BUS.addListener(RenderFrameLayerTest::renderTest); + } + + @GameTest + public static void frame_passes_run(GameTestHelper helper) { + passOne.set(false); passTwo.set(false); // pass#executes will reset to true if they run + helper.runAfterDelay(4, () -> { + helper.assertTrue(passOne.getBool(), "Pass One was not executed"); + helper.assertTrue(passTwo.getBool(), "Pass Two was not executed"); + helper.succeed(); + }); + } + + /** + * If this is working, two white line box cubes will be rendered at ground level in a superflat world around (0,0) + */ + public static void renderTest(AddFramePassEvent event) { + var mainCamera = Minecraft.getInstance().gameRenderer.getMainCamera(); + FramePassManager.PassDefinition def = new FramePassManager.PassDefinition() { + @Override + public void targets(LevelTargetBundle bundle, FramePass pass) { + bundle.main = pass.readsAndWrites(bundle.main); + } + + @Override + public void executes() { + PoseStack ps = new PoseStack(); + passOne.set(true); + ps.translate(mainCamera.getPosition().multiply(-1,-1,-1)); + ps.pushPose(); + var buffSource = Minecraft.getInstance().renderBuffers().bufferSource(); + var vc = buffSource.getBuffer(RenderType.lines()); + + ShapeRenderer.renderLineBox(ps, vc, 0, -60, 0, 10, -50, 10, 1f, 1f, 1f, 1f); + buffSource.endBatch(); + ps.popPose(); + } + }; + event.addPass(rl(MODID), def); + FramePassManager.PassDefinition def2 = new FramePassManager.PassDefinition() { + @Override + public void targets(LevelTargetBundle bundle, FramePass pass) { + bundle.main = pass.readsAndWrites(bundle.main); + } + + @Override + public void executes() { + PoseStack ps = new PoseStack(); + passTwo.set(true); + ps.translate(mainCamera.getPosition().multiply(-1,-1,-1)); + ps.pushPose(); + var buffSource = Minecraft.getInstance().renderBuffers().bufferSource(); + var vc = buffSource.getBuffer(RenderType.lines()); + + ShapeRenderer.renderLineBox(ps, vc, 1, -61, 1, 9, -49, 9, 1f, 1f, 1f, 1f); + buffSource.endBatch(); + ps.popPose(); + } + }; + event.addPass(rl(MODID+"_two"), def2); + } +} \ No newline at end of file diff --git a/src/test/resources/render_frame_layer_test/META-INF/mods.toml b/src/test/resources/render_frame_layer_test/META-INF/mods.toml new file mode 100644 index 0000000000..c361869e8e --- /dev/null +++ b/src/test/resources/render_frame_layer_test/META-INF/mods.toml @@ -0,0 +1 @@ +clientSideOnly=true \ No newline at end of file