Package net.neoforged.neoforge.client.event

Class RenderLevelStageEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.RenderLevelStageEvent

Direct Known Subclasses:

RenderLevelStageEvent.AfterEntities, RenderLevelStageEvent.AfterLevel, RenderLevelStageEvent.AfterOpaqueBlocks, RenderLevelStageEvent.AfterParticles, RenderLevelStageEvent.AfterSky, RenderLevelStageEvent.AfterTranslucentBlocks, RenderLevelStageEvent.AfterTripwireBlocks, RenderLevelStageEvent.AfterWeather

public abstract class RenderLevelStageEvent
extends net.neoforged.bus.api.Event

Fires at various times during LevelRenderer.renderLevel(com.mojang.blaze3d.resource.GraphicsResourceAllocator, net.minecraft.client.DeltaTracker, boolean, net.minecraft.client.Camera, org.joml.Matrix4f, org.joml.Matrix4f, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, org.joml.Vector4f, boolean) and GameRenderer.renderLevel(net.minecraft.client.DeltaTracker). Custom render state used in the various stages must be extracted in ExtractLevelRenderStateEvent and stored in the provided LevelRenderState

The sub-events are not cancellable.

The sub-events are fired on the main NeoForge event bus, only on the logical client.

The sub-events are fired in the following order: RenderLevelStageEvent.AfterSky, RenderLevelStageEvent.AfterOpaqueBlocks, RenderLevelStageEvent.AfterEntities, RenderLevelStageEvent.AfterTranslucentBlocks, RenderLevelStageEvent.AfterTripwireBlocks, RenderLevelStageEvent.AfterParticles, RenderLevelStageEvent.AfterWeather, RenderLevelStageEvent.AfterLevel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RenderLevelStageEvent.AfterEntities	Fired within LevelRenderer.addMainPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.renderer.culling.Frustum, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, boolean, net.minecraft.client.renderer.state.LevelRenderState, net.minecraft.client.DeltaTracker, net.minecraft.util.profiling.ProfilerFiller) after entities and block entities have been rendered.
static class	RenderLevelStageEvent.AfterLevel	Fired within GameRenderer.renderLevel(net.minecraft.client.DeltaTracker) after LevelRenderer.renderLevel(com.mojang.blaze3d.resource.GraphicsResourceAllocator, net.minecraft.client.DeltaTracker, boolean, net.minecraft.client.Camera, org.joml.Matrix4f, org.joml.Matrix4f, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, org.joml.Vector4f, boolean) is called.
static class	RenderLevelStageEvent.AfterOpaqueBlocks	Fired early in LevelRenderer.addMainPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.renderer.culling.Frustum, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, boolean, net.minecraft.client.renderer.state.LevelRenderState, net.minecraft.client.DeltaTracker, net.minecraft.util.profiling.ProfilerFiller) after solid and cutout chunk geometry has been rendered.
static class	RenderLevelStageEvent.AfterParticles	Fired at the end of LevelRenderer.addParticlesPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, com.mojang.blaze3d.buffers.GpuBufferSlice) after particles have been rendered.
static class	RenderLevelStageEvent.AfterSky	Fired at the end of LevelRenderer.addSkyPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.Camera, com.mojang.blaze3d.buffers.GpuBufferSlice) after the sky has been rendered.
static class	RenderLevelStageEvent.AfterTranslucentBlocks	Fired within LevelRenderer.addMainPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.renderer.culling.Frustum, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, boolean, net.minecraft.client.renderer.state.LevelRenderState, net.minecraft.client.DeltaTracker, net.minecraft.util.profiling.ProfilerFiller) after translucent chunk geometry has been rendered.
static class	RenderLevelStageEvent.AfterTripwireBlocks	Fired near the end of LevelRenderer.addMainPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.renderer.culling.Frustum, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, boolean, net.minecraft.client.renderer.state.LevelRenderState, net.minecraft.client.DeltaTracker, net.minecraft.util.profiling.ProfilerFiller) after tripwire chunk geometry has been rendered.
static class	RenderLevelStageEvent.AfterWeather	Fired near the end of LevelRenderer.addWeatherPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.world.phys.Vec3, com.mojang.blaze3d.buffers.GpuBufferSlice) after weather has been rendered, before world border rendering.

Field Summary

Fields

Modifier and Type	Field	Description
private final LevelRenderer	levelRenderer
private final LevelRenderState	levelRenderState
private final Matrix4f	modelViewMatrix
private final PoseStack	poseStack
private final Iterable<? extends IRenderableSection>	renderableSections

Constructor Summary

Constructors

Constructor	Description
RenderLevelStageEvent(LevelRenderer levelRenderer, LevelRenderState levelRenderState, @Nullable PoseStack poseStack, Matrix4f modelViewMatrix, Iterable<? extends IRenderableSection> renderableSections)

Method Summary

Modifier and Type	Method	Description
LevelRenderer	getLevelRenderer()	Returns the level renderer.
LevelRenderState	getLevelRenderState()	Returns the level render state.
Matrix4f	getModelViewMatrix()	Returns the model view matrix used for rendering.
PoseStack	getPoseStack()	Returns the pose stack used for rendering.
Iterable<? extends IRenderableSection>	getRenderableSections()	Returns an iterable of all visible sections.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

levelRenderer

private final LevelRenderer levelRenderer

levelRenderState

private final LevelRenderState levelRenderState

poseStack

private final PoseStack poseStack

modelViewMatrix

private final Matrix4f modelViewMatrix

renderableSections

private final Iterable<? extends IRenderableSection> renderableSections

Constructor Details

RenderLevelStageEvent

public RenderLevelStageEvent(LevelRenderer levelRenderer,
 LevelRenderState levelRenderState,
 @Nullable
 @Nullable PoseStack poseStack,
 Matrix4f modelViewMatrix,
 Iterable<? extends IRenderableSection> renderableSections)

Method Details

getLevelRenderer

public LevelRenderer getLevelRenderer()

Returns the level renderer.

Returns:

the level renderer

getLevelRenderState

public LevelRenderState getLevelRenderState()

Returns the level render state.

Returns:

the level render state

getPoseStack

public PoseStack getPoseStack()

Returns the pose stack used for rendering.

Returns:

the pose stack used for rendering

getModelViewMatrix

public Matrix4f getModelViewMatrix()

Returns the model view matrix used for rendering.

Returns:

the model view matrix used for rendering

getRenderableSections

public Iterable<? extends IRenderableSection> getRenderableSections()

Returns an iterable of all visible sections.

Calling Iterable.forEach(Consumer) on the returned iterable allows the underlying renderer to optimize how it fetches the visible sections, and is recommended.