Package net.neoforged.neoforge.client.event

Class ViewportEvent.RenderFog

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.ViewportEvent

net.neoforged.neoforge.client.event.ViewportEvent.RenderFog

Enclosing class:

ViewportEvent

public static class ViewportEvent.RenderFog
extends ViewportEvent

Fired for rendering custom fog. The plane distances are based on the player's render distance.

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

Nested Class Summary

Nested classes/interfaces inherited from class net.neoforged.neoforge.client.event.ViewportEvent

ViewportEvent.ComputeCameraAngles, ViewportEvent.ComputeFogColor, ViewportEvent.ComputeFov, ViewportEvent.RenderFog

Field Summary

Fields

Modifier and Type	Field	Description
private final @Nullable FogEnvironment	environment
private final FogData	fogData
private final FogType	type

Constructor Summary

Constructors

Constructor	Description
RenderFog(@Nullable FogEnvironment environment, FogType type, Camera camera, float partialTicks, FogData fogData)

Method Summary

Modifier and Type	Method	Description
@Nullable FogEnvironment	getEnvironment()	Returns the fog environment that was applied.
float	getFarPlaneDistance()	Returns the distance to the far plane where the fog ends.
FogData	getFogData()	The fog parameters that are passed to the shaders.
float	getNearPlaneDistance()	Returns the distance to the near plane where the fog starts.
FogType	getType()	Returns the type of fog being rendered.
void	scaleFarPlaneDistance(float factor)	Scales the distance to the far plane of the fog by a given factor.
void	scaleNearPlaneDistance(float factor)	Scales the distance to the near plane of the fog by a given factor.
void	setFarPlaneDistance(float distance)	Sets the distance to the far plane of the fog.
void	setNearPlaneDistance(float distance)	Sets the distance to the near plane of the fog.

Methods inherited from class net.neoforged.neoforge.client.event.ViewportEvent

getCamera, getPartialTick, getRenderer

Methods inherited from class java.lang.Object

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

Field Details

environment

@Nullable
private final @Nullable FogEnvironment environment

type

private final FogType type

fogData

private final FogData fogData

Constructor Details

RenderFog

@Internal
public RenderFog(@Nullable
 @Nullable FogEnvironment environment,
 FogType type,
 Camera camera,
 float partialTicks,
 FogData fogData)

Method Details

getEnvironment

@Nullable
public @Nullable FogEnvironment getEnvironment()

Returns the fog environment that was applied.

Returns:

the fog environment that was applied

getType

public FogType getType()

Returns the type of fog being rendered.

Returns:

the type of fog being rendered

getFarPlaneDistance

public float getFarPlaneDistance()

Returns the distance to the far plane where the fog ends.

Returns:

the distance to the far plane where the fog ends

getNearPlaneDistance

public float getNearPlaneDistance()

Returns the distance to the near plane where the fog starts.

Returns:

the distance to the near plane where the fog starts

getFogData

public FogData getFogData()

The fog parameters that are passed to the shaders. This object is mutable.

setFarPlaneDistance

public void setFarPlaneDistance(float distance)

Sets the distance to the far plane of the fog.

Parameters:

distance - the new distance to the far place

See Also:

• scaleFarPlaneDistance(float)

setNearPlaneDistance

public void setNearPlaneDistance(float distance)

Sets the distance to the near plane of the fog.

Parameters:

distance - the new distance to the near plane

See Also:

• scaleNearPlaneDistance(float)

scaleFarPlaneDistance

public void scaleFarPlaneDistance(float factor)

Scales the distance to the far plane of the fog by a given factor.

Parameters:

factor - the factor to scale the far plane distance by

scaleNearPlaneDistance

public void scaleNearPlaneDistance(float factor)

Scales the distance to the near plane of the fog by a given factor.

Parameters:

factor - the factor to scale the near plane distance by