From 03202a8ab48163b5278e03cce799b675f21cf496 Mon Sep 17 00:00:00 2001 From: Silver_David Date: Sat, 9 Jul 2022 12:36:47 -0400 Subject: [PATCH] [1.19.x] Added RenderLevelStageEvent to replace RenderLevelLastEvent (#8820) * Ported RenderLevelStageEvent from 1.18.2 * Updated to fix merge conflicts --- .../net/minecraft/client/Minecraft.java.patch | 7 +- .../client/renderer/LevelRenderer.java.patch | 38 ++- .../client/ForgeHooksClient.java | 19 ++ .../client/ForgeRenderTypes.java | 23 +- .../client/event/RenderLevelLastEvent.java | 3 + .../client/event/RenderLevelStageEvent.java | 232 ++++++++++++++++++ .../client/rendering/RenderableTest.java | 110 +++++++-- 7 files changed, 410 insertions(+), 22 deletions(-) create mode 100644 src/main/java/net/minecraftforge/client/event/RenderLevelStageEvent.java diff --git a/patches/minecraft/net/minecraft/client/Minecraft.java.patch b/patches/minecraft/net/minecraft/client/Minecraft.java.patch index 88412e077b..329a8e64a2 100644 --- a/patches/minecraft/net/minecraft/client/Minecraft.java.patch +++ b/patches/minecraft/net/minecraft/client/Minecraft.java.patch @@ -42,7 +42,12 @@ this.f_91038_.m_10506_(); this.f_91066_.m_92145_(this.f_91038_); this.f_91039_ = new LanguageManager(this.f_91066_.f_92075_); -@@ -500,6 +_,7 @@ +@@ -496,10 +_,12 @@ + this.f_91063_ = new GameRenderer(this, this.f_90994_.m_234586_(), this.f_91036_, this.f_90993_); + this.f_91036_.m_7217_(this.f_91063_); + this.f_91060_ = new LevelRenderer(this, this.f_90994_, this.f_167845_, this.f_90993_); ++ net.minecraftforge.fml.ModLoader.get().postEvent(new net.minecraftforge.client.event.RenderLevelStageEvent.RegisterStageEvent()); + this.f_91036_.m_7217_(this.f_91060_); this.m_91271_(); this.f_91036_.m_7217_(this.f_90997_); this.f_91061_ = new ParticleEngine(this.f_91073_, this.f_90987_); diff --git a/patches/minecraft/net/minecraft/client/renderer/LevelRenderer.java.patch b/patches/minecraft/net/minecraft/client/renderer/LevelRenderer.java.patch index f75f65f9fe..2e9060fa14 100644 --- a/patches/minecraft/net/minecraft/client/renderer/LevelRenderer.java.patch +++ b/patches/minecraft/net/minecraft/client/renderer/LevelRenderer.java.patch @@ -18,7 +18,7 @@ float f = this.f_109461_.f_91073_.m_46722_(1.0F) / (Minecraft.m_91405_() ? 1.0F : 2.0F); if (!(f <= 0.0F)) { RandomSource randomsource = RandomSource.m_216335_((long)this.f_109477_ * 312987231L); -@@ -1140,6 +_,7 @@ +@@ -1140,11 +_,13 @@ RenderSystem.m_69421_(16640, Minecraft.f_91002_); float f = p_109605_.m_109152_(); boolean flag2 = this.f_109461_.f_91073_.m_104583_().m_5781_(Mth.m_14107_(d0), Mth.m_14107_(d1)) || this.f_109461_.f_91065_.m_93090_().m_93715_(); @@ -26,6 +26,12 @@ profilerfiller.m_6182_("sky"); RenderSystem.m_157427_(GameRenderer::m_172808_); this.m_202423_(p_109600_, p_109607_, p_109601_, p_109604_, flag2, () -> { + FogRenderer.m_234172_(p_109604_, FogRenderer.FogMode.FOG_SKY, f, flag2, p_109601_); + }); ++ net.minecraftforge.client.ForgeHooksClient.dispatchRenderStage(net.minecraftforge.client.event.RenderLevelStageEvent.Stage.AFTER_SKY, this, p_109600_, p_109607_, this.f_109477_, p_109604_, frustum); + profilerfiller.m_6182_("fog"); + FogRenderer.m_234172_(p_109604_, FogRenderer.FogMode.FOG_TERRAIN, Math.max(f, 32.0F), flag2, p_109601_); + profilerfiller.m_6182_("terrain_setup"); @@ -1153,7 +_,9 @@ this.m_194370_(p_109604_); profilerfiller.m_6182_("terrain"); @@ -75,24 +81,50 @@ } PoseStack posestack = RenderSystem.m_157191_(); -@@ -1339,7 +_,7 @@ +@@ -1339,7 +_,8 @@ this.f_109415_.m_83945_(this.f_109461_.m_91385_()); RenderStateShard.f_110126_.m_110185_(); profilerfiller.m_6182_("particles"); - this.f_109461_.f_91061_.m_107336_(p_109600_, multibuffersource$buffersource, p_109606_, p_109604_, p_109601_); + this.f_109461_.f_91061_.render(p_109600_, multibuffersource$buffersource, p_109606_, p_109604_, p_109601_, frustum); ++ net.minecraftforge.client.ForgeHooksClient.dispatchRenderStage(net.minecraftforge.client.event.RenderLevelStageEvent.Stage.AFTER_PARTICLES, this, p_109600_, p_109607_, this.f_109477_, p_109604_, frustum); RenderStateShard.f_110126_.m_110188_(); } else { profilerfiller.m_6182_("translucent"); -@@ -1353,7 +_,7 @@ +@@ -1353,7 +_,8 @@ profilerfiller.m_6182_("string"); this.m_172993_(RenderType.m_110503_(), p_109600_, d0, d1, d2, p_109607_); profilerfiller.m_6182_("particles"); - this.f_109461_.f_91061_.m_107336_(p_109600_, multibuffersource$buffersource, p_109606_, p_109604_, p_109601_); + this.f_109461_.f_91061_.render(p_109600_, multibuffersource$buffersource, p_109606_, p_109604_, p_109601_, frustum); ++ net.minecraftforge.client.ForgeHooksClient.dispatchRenderStage(net.minecraftforge.client.event.RenderLevelStageEvent.Stage.AFTER_PARTICLES, this, p_109600_, p_109607_, this.f_109477_, p_109604_, frustum); } posestack.m_85836_(); +@@ -1377,6 +_,7 @@ + RenderStateShard.f_110127_.m_110185_(); + profilerfiller.m_6182_("weather"); + this.m_109703_(p_109606_, p_109601_, d0, d1, d2); ++ net.minecraftforge.client.ForgeHooksClient.dispatchRenderStage(net.minecraftforge.client.event.RenderLevelStageEvent.Stage.AFTER_WEATHER, this, p_109600_, p_109607_, this.f_109477_, p_109604_, frustum); + this.m_173012_(p_109604_); + RenderStateShard.f_110127_.m_110188_(); + this.f_109418_.m_110023_(p_109601_); +@@ -1385,6 +_,7 @@ + RenderSystem.m_69458_(false); + profilerfiller.m_6182_("weather"); + this.m_109703_(p_109606_, p_109601_, d0, d1, d2); ++ net.minecraftforge.client.ForgeHooksClient.dispatchRenderStage(net.minecraftforge.client.event.RenderLevelStageEvent.Stage.AFTER_WEATHER, this, p_109600_, p_109607_, this.f_109477_, p_109604_, frustum); + this.m_173012_(p_109604_); + RenderSystem.m_69458_(true); + } +@@ -1519,6 +_,7 @@ + shaderinstance.m_173362_(); + VertexBuffer.m_85931_(); + this.f_109461_.m_91307_().m_7238_(); ++ net.minecraftforge.client.ForgeHooksClient.dispatchRenderStage(p_172994_, this, p_172995_, p_172999_, this.f_109477_, this.f_109461_.f_91063_.m_109153_(), this.f_109442_ != null ? this.f_109442_ : this.f_172938_); + p_172994_.m_110188_(); + } + @@ -1780,6 +_,8 @@ } diff --git a/src/main/java/net/minecraftforge/client/ForgeHooksClient.java b/src/main/java/net/minecraftforge/client/ForgeHooksClient.java index 333666767f..b221ccdd3e 100755 --- a/src/main/java/net/minecraftforge/client/ForgeHooksClient.java +++ b/src/main/java/net/minecraftforge/client/ForgeHooksClient.java @@ -55,6 +55,7 @@ import net.minecraft.client.renderer.ShaderInstance; import net.minecraft.client.renderer.Sheets; import net.minecraft.client.renderer.block.BlockRenderDispatcher; import net.minecraft.client.renderer.block.model.ItemTransforms; +import net.minecraft.client.renderer.culling.Frustum; import net.minecraft.client.renderer.texture.TextureAtlas; import net.minecraft.client.renderer.texture.TextureAtlasSprite; import net.minecraft.client.resources.language.I18n; @@ -121,6 +122,7 @@ import net.minecraftforge.client.event.RenderBlockScreenEffectEvent; import net.minecraftforge.client.event.RenderHandEvent; import net.minecraftforge.client.event.RenderHighlightEvent; import net.minecraftforge.client.event.RenderLevelLastEvent; +import net.minecraftforge.client.event.RenderLevelStageEvent; import net.minecraftforge.client.event.RenderTooltipEvent; import net.minecraftforge.client.event.ScreenEvent; import net.minecraftforge.client.event.ScreenshotEvent; @@ -259,11 +261,28 @@ public class ForgeHooksClient } } + @Deprecated(forRemoval = true, since = "1.19") public static void dispatchRenderLast(LevelRenderer context, PoseStack poseStack, float partialTick, Matrix4f projectionMatrix, long finishTimeNano) { MinecraftForge.EVENT_BUS.post(new RenderLevelLastEvent(context, poseStack, partialTick, projectionMatrix, finishTimeNano)); } + public static void dispatchRenderStage(RenderLevelStageEvent.Stage stage, LevelRenderer levelRenderer, PoseStack poseStack, Matrix4f projectionMatrix, int renderTick, Camera camera, Frustum frustum) + { + var mc = Minecraft.getInstance(); + var profiler = mc.getProfiler(); + profiler.push(stage.toString()); + MinecraftForge.EVENT_BUS.post(new RenderLevelStageEvent(stage, levelRenderer, poseStack, projectionMatrix, renderTick, mc.getPartialTick(), camera, frustum)); + profiler.pop(); + } + + public static void dispatchRenderStage(RenderType renderType, LevelRenderer levelRenderer, PoseStack poseStack, Matrix4f projectionMatrix, int renderTick, Camera camera, Frustum frustum) + { + RenderLevelStageEvent.Stage stage = RenderLevelStageEvent.Stage.fromRenderType(renderType); + if (stage != null) + dispatchRenderStage(stage, levelRenderer, poseStack, projectionMatrix, renderTick, camera, frustum); + } + public static boolean renderSpecificFirstPersonHand(InteractionHand hand, PoseStack poseStack, MultiBufferSource bufferSource, int packedLight, float partialTick, float interpPitch, float swingProgress, float equipProgress, ItemStack stack) { return MinecraftForge.EVENT_BUS.post(new RenderHandEvent(hand, poseStack, bufferSource, packedLight, partialTick, interpPitch, swingProgress, equipProgress, stack)); diff --git a/src/main/java/net/minecraftforge/client/ForgeRenderTypes.java b/src/main/java/net/minecraftforge/client/ForgeRenderTypes.java index 2cc0f6c7df..3af7140d65 100644 --- a/src/main/java/net/minecraftforge/client/ForgeRenderTypes.java +++ b/src/main/java/net/minecraftforge/client/ForgeRenderTypes.java @@ -32,7 +32,8 @@ public enum ForgeRenderTypes ITEM_LAYERED_TRANSLUCENT(()-> getItemLayeredTranslucent(TextureAtlas.LOCATION_BLOCKS)), ITEM_UNSORTED_TRANSLUCENT(()-> getUnsortedTranslucent(TextureAtlas.LOCATION_BLOCKS)), ITEM_UNLIT_TRANSLUCENT(()-> getUnlitTranslucent(TextureAtlas.LOCATION_BLOCKS)), - ITEM_UNSORTED_UNLIT_TRANSLUCENT(()-> getUnlitTranslucent(TextureAtlas.LOCATION_BLOCKS, false)); + ITEM_UNSORTED_UNLIT_TRANSLUCENT(()-> getUnlitTranslucent(TextureAtlas.LOCATION_BLOCKS, false)), + TRANSLUCENT_ON_PARTICLES_TARGET(() -> getTranslucentParticlesTarget(TextureAtlas.LOCATION_BLOCKS)); public static boolean enableTextTextureLinearFiltering = false; @@ -151,6 +152,14 @@ public enum ForgeRenderTypes return Internal.TEXT_INTENSITY_SEETHROUGH.apply(locationIn); } + /** + * @return A variation of {@link RenderType#translucent()} that uses {@link OutputStateShard#PARTICLES_TARGET} to allow fabulous transparency sorting when using {@link RenderLevelStageEvent} + */ + public static RenderType getTranslucentParticlesTarget(ResourceLocation locationIn) + { + return Internal.TRANSLUCENT_PARTICLES_TARGET.apply(locationIn); + } + // ---------------------------------------- // Implementation details below this line // ---------------------------------------- @@ -340,6 +349,18 @@ public enum ForgeRenderTypes .createCompositeState(false); return create("forge_text_see_through", DefaultVertexFormat.POSITION_COLOR_TEX_LIGHTMAP, VertexFormat.Mode.QUADS, 256, false, true, rendertype$state); } + + public static Function TRANSLUCENT_PARTICLES_TARGET = Util.memoize(Internal::getTranslucentParticlesTarget); + private static RenderType getTranslucentParticlesTarget(ResourceLocation locationIn) { + RenderType.CompositeState rendertype$state = RenderType.CompositeState.builder() + .setShaderState(RENDERTYPE_TRANSLUCENT_SHADER) + .setTextureState(new RenderStateShard.TextureStateShard(locationIn, false, true)) + .setTransparencyState(TRANSLUCENT_TRANSPARENCY) + .setLightmapState(LIGHTMAP) + .setOutputState(PARTICLES_TARGET) + .createCompositeState(true); + return create("forge_translucent_particles_target", DefaultVertexFormat.BLOCK, VertexFormat.Mode.QUADS, 2097152, true, true, rendertype$state); + } } private static class CustomizableTextureState extends TextureStateShard diff --git a/src/main/java/net/minecraftforge/client/event/RenderLevelLastEvent.java b/src/main/java/net/minecraftforge/client/event/RenderLevelLastEvent.java index 2076d99c65..e9280d78e9 100644 --- a/src/main/java/net/minecraftforge/client/event/RenderLevelLastEvent.java +++ b/src/main/java/net/minecraftforge/client/event/RenderLevelLastEvent.java @@ -23,9 +23,12 @@ import org.jetbrains.annotations.ApiStatus; *

This event is fired on the {@linkplain MinecraftForge#EVENT_BUS main Forge event bus}, * only on the {@linkplain LogicalSide#CLIENT logical client}.

* + * @deprecated Use {@link RenderLevelStageEvent} instead for more flexibility and improved compatibility with translucent objects. + * There is no {@link RenderLevelStageEvent.Stage} that directly replaces this event, instead you must decide which Stage best fits your use case. * @see GameRenderer * @see LevelRenderer */ +@Deprecated(forRemoval = true, since = "1.19") public class RenderLevelLastEvent extends net.minecraftforge.eventbus.api.Event { private final LevelRenderer levelRenderer; diff --git a/src/main/java/net/minecraftforge/client/event/RenderLevelStageEvent.java b/src/main/java/net/minecraftforge/client/event/RenderLevelStageEvent.java new file mode 100644 index 0000000000..4896eee70b --- /dev/null +++ b/src/main/java/net/minecraftforge/client/event/RenderLevelStageEvent.java @@ -0,0 +1,232 @@ +/* + * Copyright (c) Forge Development LLC and contributors + * SPDX-License-Identifier: LGPL-2.1-only + */ + +package net.minecraftforge.client.event; + +import java.util.HashMap; +import java.util.Map; + +import javax.annotation.Nullable; + +import com.mojang.blaze3d.vertex.PoseStack; +import com.mojang.math.Matrix4f; + +import net.minecraft.client.Camera; +import net.minecraft.client.renderer.LevelRenderer; +import net.minecraft.client.renderer.RenderType; +import net.minecraft.client.renderer.culling.Frustum; +import net.minecraft.resources.ResourceLocation; +import net.minecraftforge.client.ForgeRenderTypes; +import net.minecraftforge.eventbus.api.Event; +import net.minecraftforge.fml.event.IModBusEvent; + +/** + * Fires at various times during LevelRenderer.renderLevel. + * Check {@link #getStage} to render during the appropriate time for your use case. + * + *

This event is not {@linkplain Cancelable cancellable}, and does not {@linkplain HasResult have a result}.

+ * + *

This event is fired on the {@linkplain MinecraftForge#EVENT_BUS main Forge event bus}, + * only on the {@linkplain LogicalSide#CLIENT logical client}.

+ */ +public class RenderLevelStageEvent extends Event +{ + private final Stage stage; + private final LevelRenderer levelRenderer; + private final PoseStack poseStack; + private final Matrix4f projectionMatrix; + private final int renderTick; + private final float partialTick; + private final Camera camera; + private final Frustum frustum; + + public RenderLevelStageEvent(Stage stage, LevelRenderer levelRenderer, PoseStack poseStack, Matrix4f projectionMatrix, int renderTick, float partialTick, Camera camera, Frustum frustum) + { + this.stage = stage; + this.levelRenderer = levelRenderer; + this.poseStack = poseStack; + this.projectionMatrix = projectionMatrix; + this.renderTick = renderTick; + this.partialTick = partialTick; + this.camera = camera; + this.frustum = frustum; + } + + /** + * {@return the current {@linkplain Stage stage} that is being rendered. Check this before doing rendering to ensure + * that rendering happens at the appropriate time.} + */ + public Stage getStage() + { + return stage; + } + + /** + * {@return the level renderer} + */ + public LevelRenderer getLevelRenderer() + { + return levelRenderer; + } + + /** + * {@return the pose stack used for rendering} + */ + public PoseStack getPoseStack() + { + return poseStack; + } + + /** + * {@return the projection matrix} + */ + public Matrix4f getProjectionMatrix() + { + return projectionMatrix; + } + + /** + * {@return the current "ticks" value in the {@linkplain LevelRenderer level renderer}} + */ + public int getRenderTick() + { + return renderTick; + } + + /** + * {@return the current partialTick value used for rendering} + */ + public float getPartialTick() + { + return partialTick; + } + + /** + * {@return the camera} + */ + public Camera getCamera() + { + return camera; + } + + /** + * {@return the frustum} + */ + public Frustum getFrustum() + { + return frustum; + } + + /** + * Use to create a custom {@linkplain RenderLevelStageEvent.Stage stages}. + * Fired after the LevelRenderer has been created. + * + *

This event is not {@linkplain Cancelable cancellable}, and does not {@linkplain HasResult have a result}.

+ * + *

This event is fired on the {@linkplain FMLJavaModLoadingContext#getModEventBus() mod-specific event bus}, + * only on the {@linkplain LogicalSide#CLIENT logical client}.

+ */ + public static class RegisterStageEvent extends Event implements IModBusEvent + { + /** + * @param name The name of your Stage. + * @param renderType + * If not null, called automatically by LevelRenderer.renderChunkLayer if the RenderType passed into it matches this one. + * If null, needs to be called manually by whoever implements it. + * + * @throws IllegalArgumentException if the RenderType passed is already mapped to a Stage. + */ + public Stage register(ResourceLocation name, @Nullable RenderType renderType) throws IllegalArgumentException + { + return Stage.register(name, renderType); + } + } + + /** + * A time during level rendering for you to render custom things into the world. + * @see RegisterStageEvent + */ + public static class Stage + { + private static final Map RENDER_TYPE_STAGES = new HashMap<>(); + + /** + * Use this to render custom objects into the skybox. + * Called regardless of if they sky actually renders or not. + */ + public static final Stage AFTER_SKY = register("after_sky", null); + /** + * Use this to render custom block-like geometry into the world. + */ + public static final Stage AFTER_SOLID_BLOCKS = register("after_solid_blocks", RenderType.solid()); + /** + * Use this to render custom block-like geometry into the world. + */ + public static final Stage AFTER_CUTOUT_MIPPED_BLOCKS_BLOCKS = register("after_cutout_mipped_blocks", RenderType.cutoutMipped()); + /** + * Use this to render custom block-like geometry into the world. + */ + public static final Stage AFTER_CUTOUT_BLOCKS = register("after_cutout_blocks", RenderType.cutout()); + /** + * Use this to render custom block-like geometry into the world. + * Due to how transparency sorting works, this stage may not work properly with translucency. If you intend to render translucency, + * try using {@link #AFTER_TRIPWIRE_BLOCKS} or {@link #AFTER_PARTICLES}. + * Although this is called within a fabulous graphics target, it does not function properly in many cases. + */ + public static final Stage AFTER_TRANSLUCENT_BLOCKS = register("after_translucent_blocks", RenderType.translucent()); + /** + * Use this to render custom block-like geometry into the world. + */ + public static final Stage AFTER_TRIPWIRE_BLOCKS = register("after_tripwire_blocks", RenderType.tripwire()); + /** + * Use this to render custom effects into the world, such as custom entity-like objects or special rendering effects. + * Called within a fabulous graphics target. + * Happens after entities render. + * + * @see ForgeRenderTypes#TRANSLUCENT_ON_PARTICLES_TARGET + */ + public static final Stage AFTER_PARTICLES = register("after_particles", null); + /** + * Use this to render custom weather effects into the world. + * Called within a fabulous graphics target. + */ + public static final Stage AFTER_WEATHER = register("after_weather", null); + + private final String name; + + private Stage(String name) + { + this.name = name; + } + + private static Stage register(ResourceLocation name, @Nullable RenderType renderType) throws IllegalArgumentException + { + Stage stage = new Stage(name.toString()); + if (renderType != null && RENDER_TYPE_STAGES.putIfAbsent(renderType, stage) != null) + throw new IllegalArgumentException("Attempted to replace an existing RenderLevelStageEvent.Stage for a RenderType: Stage = " + stage + ", RenderType = " + renderType); + return stage; + } + + private static Stage register(String name, @Nullable RenderType renderType) throws IllegalArgumentException + { + return register(new ResourceLocation(name), renderType); + } + + @Override + public String toString() + { + return this.name; + } + + /** + * {@return the {@linkplain Stage stage} bound to the {@linkplain RenderType render type}, or null if no value is present} + */ + @Nullable + public static Stage fromRenderType(RenderType renderType) + { + return RENDER_TYPE_STAGES.get(renderType); + } + } +} diff --git a/src/test/java/net/minecraftforge/debug/client/rendering/RenderableTest.java b/src/test/java/net/minecraftforge/debug/client/rendering/RenderableTest.java index e15c49b988..8c336fd64e 100644 --- a/src/test/java/net/minecraftforge/debug/client/rendering/RenderableTest.java +++ b/src/test/java/net/minecraftforge/debug/client/rendering/RenderableTest.java @@ -5,21 +5,33 @@ package net.minecraftforge.debug.client.rendering; +import java.util.Map; + +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; + import com.google.common.collect.ImmutableMap; +import com.mojang.blaze3d.vertex.PoseStack; import com.mojang.math.Matrix4f; import com.mojang.math.Quaternion; + import net.minecraft.client.Minecraft; import net.minecraft.client.renderer.LightTexture; import net.minecraft.client.renderer.RenderType; import net.minecraft.client.renderer.texture.OverlayTexture; +import net.minecraft.core.BlockPos; import net.minecraft.resources.ResourceLocation; import net.minecraft.server.packs.resources.ResourceManager; import net.minecraft.server.packs.resources.SimplePreparableReloadListener; import net.minecraft.util.profiling.ProfilerFiller; +import net.minecraft.world.phys.Vec3; import net.minecraftforge.api.distmarker.Dist; +import net.minecraftforge.client.ForgeRenderTypes; import net.minecraftforge.client.event.ModelEvent; import net.minecraftforge.client.event.RegisterClientReloadListenersEvent; import net.minecraftforge.client.event.RenderLevelLastEvent; +import net.minecraftforge.client.event.RenderLevelStageEvent; +import net.minecraftforge.client.event.RenderLevelStageEvent.Stage; import net.minecraftforge.client.model.geometry.StandaloneGeometryBakingContext; import net.minecraftforge.client.model.data.ModelData; import net.minecraftforge.client.model.obj.ObjLoader; @@ -32,14 +44,25 @@ import net.minecraftforge.fml.common.Mod; import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext; import net.minecraftforge.fml.loading.FMLEnvironment; -import java.util.Map; - +/** + * This mod is testing the use of {@link RenderLevelStageEvent} and is a modifaction of a pre-existing test mod that used the old + * {@link RenderLevelLastEvent}. To restore the old behavior, set {@link #USE_LEVEL_RENDERER_STAGE} to false. + * + * When you enter a world, there should be 6 sugar gliders rendering at (0, 120, 0) that test the various stages in {@link RenderLevelStageEvent}. + * From left to right (with the sugar gliders facing you) they represent {@link Stage#AFTER_SKY}, {@link Stage#AFTER_SOLID_BLOCKS}, + * {@link Stage#AFTER_TRANSLUCENT_BLOCKS}, {@link Stage#AFTER_TRIPWIRE_BLOCKS}, {@link Stage#AFTER_PARTICLES}, and {@link Stage#AFTER_WEATHER}. + * Due to how weather modifies the projection matrix, it's sugar glider will be positioned weirdly. Below each sugar gliders is a render of + * blue stained glass to test translucency with fabulous graphics. {@link Stage#AFTER_PARTICLES} will render the stained glass using + * {@link ForgeRenderTypes#TRANSLUCENT_ON_PARTICLES_TARGET}. + */ @Mod(RenderableTest.MODID) public class RenderableTest { public static final String MODID = "renderable_test"; + private static final Logger LOGGER = LogManager.getLogger(); - public static final boolean ENABLED = false; + public static final boolean ENABLED = true; // Renders at (0, 120, 0) + public static final boolean USE_LEVEL_RENDERER_STAGE = true; // True when using RenderLevelStageEvent. False when using RenderLevelLastEvent public RenderableTest() { @@ -54,17 +77,24 @@ public class RenderableTest private static class Client { - private static ResourceLocation MODEL_LOC = new ResourceLocation("minecraft:block/diamond_block"); + private static ResourceLocation MODEL_LOC = new ResourceLocation("minecraft:block/blue_stained_glass"); private static IRenderable renderable; private static IRenderable bakedRenderable; public static void init() { - var bus = FMLJavaModLoadingContext.get().getModEventBus(); - bus.addListener(Client::registerModels); - bus.addListener(Client::registerReloadListeners); - MinecraftForge.EVENT_BUS.addListener(Client::renderLast); + var modBus = FMLJavaModLoadingContext.get().getModEventBus(); + var forgeBus = MinecraftForge.EVENT_BUS; + modBus.addListener(Client::registerModels); + modBus.addListener(Client::registerReloadListeners); + if (USE_LEVEL_RENDERER_STAGE) + { + modBus.addListener(Client::registerStage); + forgeBus.addListener(Client::renderStage); + } + else + forgeBus.addListener(Client::renderLast); } private static void registerModels(ModelEvent.RegisterAdditional event) @@ -101,42 +131,88 @@ public class RenderableTest }); } - private static double time; + public static void registerStage(RenderLevelStageEvent.RegisterStageEvent event) + { + var stage = event.register(new ResourceLocation(MODID, "test_stage"), null); + LOGGER.info("Registered RenderLevelStageEvent.Stage: {}", stage); + } public static void renderLast(RenderLevelLastEvent event) { + Vec3 cam = Minecraft.getInstance().gameRenderer.getMainCamera().getPosition(); + render(Stage.AFTER_SKY, event.getPoseStack(), 0, event.getPartialTick(), cam.x, cam.y, cam.z, 0); + } + + private static void renderStage(RenderLevelStageEvent event) + { + int xOffset = -1; + var stage = event.getStage(); + if (stage == Stage.AFTER_SKY) + xOffset = 0; + else if (stage == Stage.AFTER_SOLID_BLOCKS) + xOffset = 1; + else if (stage == Stage.AFTER_TRANSLUCENT_BLOCKS) + xOffset = 2; + else if (stage == Stage.AFTER_TRIPWIRE_BLOCKS) + xOffset = 3; + else if (stage == Stage.AFTER_PARTICLES) + xOffset = 4; + else if (stage == Stage.AFTER_WEATHER) + xOffset = 5; + + Vec3 cam = event.getCamera().getPosition(); + if (xOffset > -1) + render(stage, event.getPoseStack(), event.getRenderTick(), event.getPartialTick(), cam.x, cam.y, cam.z, xOffset); + } + + private static void render(Stage stage, PoseStack poseStack, int renderTick, float partialTick, double camX, double camY, double camZ, int xOffset) + { + double x = camX, y = camY, z = camZ; + if (!new BlockPos(0, y, 0).closerThan(new BlockPos(x, y, z), 100)) + return; + + var profiler = Minecraft.getInstance().getProfiler(); + profiler.push("renderable_test"); if (bakedRenderable == null) { bakedRenderable = BakedModelRenderable.of(MODEL_LOC).withModelDataContext(); } - var poseStack = event.getPoseStack(); var bufferSource = Minecraft.getInstance().renderBuffers().bufferSource(); - time += Minecraft.getInstance().getDeltaFrameTime(); + double time = renderTick + partialTick; var map = ImmutableMap.builder(); var left = new Matrix4f(); left.setIdentity(); - left.multiply(Quaternion.fromYXZ(0, 0, (float)Math.sin(time * 0.05) * 0.1f)); + left.multiply(Quaternion.fromYXZ(0, 0, (float)Math.sin(time * 0.4) * 0.1f)); map.put("object_1", left); var right = new Matrix4f(); right.setIdentity(); - right.multiply(Quaternion.fromYXZ(0, 0, -(float)Math.sin(time * 0.05) * 0.1f)); + right.multiply(Quaternion.fromYXZ(0, 0, -(float)Math.sin(time * 0.4) * 0.1f)); map.put("object_9", right); var transforms = CompositeRenderable.Transforms.of(map.build()); - renderable.render(poseStack, bufferSource, RenderType::entitySolid, LightTexture.FULL_BRIGHT, OverlayTexture.NO_OVERLAY, event.getPartialTick(), transforms); - poseStack.pushPose(); - poseStack.translate(0,0.5f,0); - bakedRenderable.render(poseStack, bufferSource, RenderType::entitySolid, LightTexture.FULL_BRIGHT, OverlayTexture.NO_OVERLAY, event.getPartialTick(), ModelData.EMPTY); + poseStack.translate(0 - x + xOffset, 120 - y, 0 - z); + renderable.render(poseStack, bufferSource, RenderType::entitySolid, LightTexture.FULL_BRIGHT, OverlayTexture.NO_OVERLAY, partialTick, transforms); + + poseStack.translate(0, -1, 0); + bakedRenderable.render(poseStack, bufferSource, texture -> getRenderType(stage, texture), LightTexture.FULL_BRIGHT, OverlayTexture.NO_OVERLAY, partialTick, ModelData.EMPTY); poseStack.popPose(); bufferSource.endBatch(); + profiler.pop(); + } + + private static RenderType getRenderType(Stage stage, ResourceLocation texture) + { + if (stage == Stage.AFTER_PARTICLES) + return ForgeRenderTypes.TRANSLUCENT_ON_PARTICLES_TARGET.get(); + return RenderType.entityTranslucent(texture); } } }