Class FrameGraphSetupEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.FrameGraphSetupEvent

public final class FrameGraphSetupEvent
extends net.neoforged.bus.api.Event

Fired when the frame graph is set up at the start of level rendering, right before the vanilla frame passes are set up.

This event is not cancellable.

This event is fired on the main Forge event bus, only on the logical client.

Field Summary

Fields

Modifier and Type	Field	Description
private final FrameGraphBuilder	builder
private final CameraRenderState	cameraState
private final DeltaTracker	deltaTracker
private boolean	enableOutline
private final Frustum	frustum
private final Matrix4f	modelViewMatrix
private final ProfilerFiller	profiler
private final RenderTargetDescriptor	renderTargetDescriptor
private final LevelTargetBundle	targets

Constructor Summary

Constructors

Constructor	Description
FrameGraphSetupEvent(FrameGraphBuilder builder, LevelTargetBundle targets, RenderTargetDescriptor renderTargetDescriptor, CameraRenderState cameraState, Matrix4f modelViewMatrix, DeltaTracker deltaTracker, ProfilerFiller profiler)

Method Summary

Modifier and Type	Method	Description
void	enableOutlineProcessing()	Enables the entity outline post-processing shader regardless of any entities having active outlines
CameraRenderState	getCameraState()	Returns the CameraRenderState.
DeltaTracker	getDeltaTracker()	Returns the DeltaTracker.
FrameGraphBuilder	getFrameGrapBuilder()	Returns the FrameGraphBuilder used to set up the frame graph.
Frustum	getFrustum()	Returns the culling frustum.
Matrix4f	getModelViewMatrix()	Returns the model view matrix.
ProfilerFiller	getProfiler()	Returns the active profiler.
RenderTargetDescriptor	getRenderTargetDescriptor()	Returns the render target descriptor to use for creating full-screen render targets.
LevelTargetBundle	getTargetBundle()	Returns the render targets used during level rendering.
boolean	isOutlineProcessingEnabled()	Returns whether the entity outline post-processing shader will be enabled regardless of entities using it.

Methods inherited from class Object

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

Field Details

builder

private final FrameGraphBuilder builder

targets

private final LevelTargetBundle targets

renderTargetDescriptor

private final RenderTargetDescriptor renderTargetDescriptor

frustum

private final Frustum frustum

cameraState

private final CameraRenderState cameraState

modelViewMatrix

private final Matrix4f modelViewMatrix

deltaTracker

private final DeltaTracker deltaTracker

profiler

private final ProfilerFiller profiler

enableOutline

private boolean enableOutline

Constructor Details

FrameGraphSetupEvent

@Internal
public FrameGraphSetupEvent(FrameGraphBuilder builder,
 LevelTargetBundle targets,
 RenderTargetDescriptor renderTargetDescriptor,
 CameraRenderState cameraState,
 Matrix4f modelViewMatrix,
 DeltaTracker deltaTracker,
 ProfilerFiller profiler)

Method Details

getFrameGrapBuilder

public FrameGraphBuilder getFrameGrapBuilder()

Returns the FrameGraphBuilder used to set up the frame graph.

Returns:

the FrameGraphBuilder used to set up the frame graph

getTargetBundle

public LevelTargetBundle getTargetBundle()

Returns the render targets used during level rendering.

Returns:

the render targets used during level rendering

getRenderTargetDescriptor

public RenderTargetDescriptor getRenderTargetDescriptor()

Returns the render target descriptor to use for creating full-screen render targets.

Returns:

the render target descriptor to use for creating full-screen render targets

getFrustum

public Frustum getFrustum()

Returns the culling frustum.

Returns:

the culling frustum

getCameraState

public CameraRenderState getCameraState()

Returns the CameraRenderState. extracted from the active Camera

Returns:

the CameraRenderState

getModelViewMatrix

public Matrix4f getModelViewMatrix()

Returns the model view matrix.

Returns:

the model view matrix

getDeltaTracker

public DeltaTracker getDeltaTracker()

Returns the DeltaTracker.

Returns:

the DeltaTracker

getProfiler

public ProfilerFiller getProfiler()

Returns the active profiler.

Returns:

the active profiler

enableOutlineProcessing

public void enableOutlineProcessing()

Enables the entity outline post-processing shader regardless of any entities having active outlines

isOutlineProcessingEnabled

public boolean isOutlineProcessingEnabled()

Returns whether the entity outline post-processing shader will be enabled regardless of entities using it.

Returns:

whether the entity outline post-processing shader will be enabled regardless of entities using it