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.AfterBlockEntities, 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, com.mojang.blaze3d.buffers.GpuBufferSlice, org.joml.Vector4f, boolean) and GameRenderer.renderLevel(net.minecraft.client.DeltaTracker)

The sub-events are not cancellable.

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

The current order that the sub-events fire in are: AfterSky, AfterOpaqueBlocks, AfterEntities, AfterBlockEntities, AfterTranslucentBlocks, AfterTripwireBlocks, AfterParticles, AfterWeather, AfterLevel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RenderLevelStageEvent.AfterBlockEntities	Fired within LevelRenderer.addMainPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.renderer.culling.Frustum, net.minecraft.client.Camera, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, boolean, boolean, net.minecraft.client.DeltaTracker, net.minecraft.util.profiling.ProfilerFiller) after AfterEntities had ran and just before block outline rendering.
static class	RenderLevelStageEvent.AfterEntities	Fired within LevelRenderer.addMainPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.renderer.culling.Frustum, net.minecraft.client.Camera, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, boolean, boolean, net.minecraft.client.DeltaTracker, net.minecraft.util.profiling.ProfilerFiller) after AfterOpaqueBlocks had ran.
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, 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, net.minecraft.client.Camera, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, boolean, boolean, net.minecraft.client.DeltaTracker, net.minecraft.util.profiling.ProfilerFiller) after AfterSky had ran.
static class	RenderLevelStageEvent.AfterParticles	Fired at the end of LevelRenderer.addParticlesPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.Camera, float, com.mojang.blaze3d.buffers.GpuBufferSlice) after AfterTripwireBlocks had ran.
static class	RenderLevelStageEvent.AfterSky	Fired at the end of LevelRenderer.addSkyPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.Camera, float, com.mojang.blaze3d.buffers.GpuBufferSlice).
static class	RenderLevelStageEvent.AfterTranslucentBlocks	Fired within LevelRenderer.addMainPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.renderer.culling.Frustum, net.minecraft.client.Camera, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, boolean, boolean, net.minecraft.client.DeltaTracker, net.minecraft.util.profiling.ProfilerFiller) after AfterBlockEntities had ran.
static class	RenderLevelStageEvent.AfterTripwireBlocks	Fired near the end of LevelRenderer.addMainPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.renderer.culling.Frustum, net.minecraft.client.Camera, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, boolean, boolean, net.minecraft.client.DeltaTracker, net.minecraft.util.profiling.ProfilerFiller) after AfterTranslucentBlocks had ran.
static class	RenderLevelStageEvent.AfterWeather	Fired near the end of LevelRenderer.addWeatherPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.world.phys.Vec3, float, com.mojang.blaze3d.buffers.GpuBufferSlice) after AfterParticles had ran but before world border rendering.

Field Summary

Fields

Modifier and Type	Field	Description
private final Camera	camera
private final Frustum	frustum
private final Level	level
private final LevelRenderer	levelRenderer
private final Matrix4f	modelViewMatrix
private final DeltaTracker	partialTick
private final PoseStack	poseStack
private final Iterable<? extends IRenderableSection>	renderableSections
private final int	renderTick

Constructor Summary

Constructors

Constructor	Description
RenderLevelStageEvent(Level level, LevelRenderer levelRenderer, @Nullable PoseStack poseStack, Matrix4f modelViewMatrix, int renderTick, DeltaTracker partialTick, Camera camera, Frustum frustum, Iterable<? extends IRenderableSection> renderableSections)

Method Summary

Modifier and Type	Method	Description
Camera	getCamera()	Returns the camera.
Frustum	getFrustum()	Returns the frustum.
Level	getLevel()	Returns the current level that is being rendered..
LevelRenderer	getLevelRenderer()	Returns the level renderer.
Matrix4f	getModelViewMatrix()	Returns the model view matrix used for rendering.
DeltaTracker	getPartialTick()	Returns the current partialTick value used for rendering.
PoseStack	getPoseStack()	Returns the pose stack used for rendering.
Iterable<? extends IRenderableSection>	getRenderableSections()	Returns an iterable of all visible sections.
int	getRenderTick()	Returns the current "ticks" value in the level renderer.

Methods inherited from class java.lang.Object

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

Field Details

level

private final Level level

levelRenderer

private final LevelRenderer levelRenderer

poseStack

private final PoseStack poseStack

modelViewMatrix

private final Matrix4f modelViewMatrix

renderTick

private final int renderTick

partialTick

private final DeltaTracker partialTick

camera

private final Camera camera

frustum

private final Frustum frustum

renderableSections

private final Iterable<? extends IRenderableSection> renderableSections

Constructor Details

RenderLevelStageEvent

public RenderLevelStageEvent(Level level,
 LevelRenderer levelRenderer,
 @Nullable
 @Nullable PoseStack poseStack,
 Matrix4f modelViewMatrix,
 int renderTick,
 DeltaTracker partialTick,
 Camera camera,
 Frustum frustum,
 Iterable<? extends IRenderableSection> renderableSections)

Method Details

getLevel

public Level getLevel()

Returns the current level that is being rendered..

Returns:

the current level that is being rendered.

getLevelRenderer

public LevelRenderer getLevelRenderer()

Returns the level renderer.

Returns:

the level renderer

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

getRenderTick

public int getRenderTick()

Returns the current "ticks" value in the level renderer.

Returns:

the current "ticks" value in the level renderer

getPartialTick

public DeltaTracker getPartialTick()

Returns the current partialTick value used for rendering.

Returns:

the current partialTick value used for rendering

getCamera

public Camera getCamera()

Returns the camera.

Returns:

the camera

getFrustum

public Frustum getFrustum()

Returns the frustum.

Returns:

the frustum

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.