Package net.minecraftforge.client.event

Class RegisterShadersEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.client.event.RegisterShadersEvent

All Implemented Interfaces:

IModBusEvent

public class RegisterShadersEvent
extends net.minecraftforge.eventbus.api.Event
implements IModBusEvent

Fired to allow mods to register custom shaders. This event is fired after the default Minecraft shaders have been registered.

This event is not cancellable, and does not have a result.

This event is fired on the mod-specific event bus, only on the logical client.

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event

net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
private final ResourceProvider	resourceProvider
private final List<com.mojang.datafixers.util.Pair<ShaderInstance,Consumer<ShaderInstance>>>	shaderList

Constructor Summary

Constructors

Constructor	Description
RegisterShadersEvent(ResourceProvider resourceProvider, List<com.mojang.datafixers.util.Pair<ShaderInstance,Consumer<ShaderInstance>>> shaderList)

Method Summary

Modifier and Type	Method	Description
ResourceProvider	getResourceProvider()	Returns the client-side resource provider.
void	registerShader(ShaderInstance shaderInstance, Consumer<ShaderInstance> onLoaded)	Registers a shader, and a callback for when the shader is loaded.

Methods inherited from class net.minecraftforge.eventbus.api.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult

Methods inherited from class java.lang.Object

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

Field Details

resourceProvider

private final ResourceProvider resourceProvider

shaderList

private final List<com.mojang.datafixers.util.Pair<ShaderInstance,Consumer<ShaderInstance>>> shaderList

Constructor Details

RegisterShadersEvent

@Internal
public RegisterShadersEvent(ResourceProvider resourceProvider,
 List<com.mojang.datafixers.util.Pair<ShaderInstance,Consumer<ShaderInstance>>> shaderList)

Method Details

getResourceProvider

public ResourceProvider getResourceProvider()

Returns the client-side resource provider.

Returns:

the client-side resource provider

registerShader

public void registerShader(ShaderInstance shaderInstance,
 Consumer<ShaderInstance> onLoaded)

Registers a shader, and a callback for when the shader is loaded.

When creating a ShaderInstance, pass in the client-side resource provider as the resource provider.

Mods should not store the shader instance passed into this method. Instead, mods should store the shader passed into the registered load callback.

Parameters:

shaderInstance - a shader

onLoaded - a callback for when the shader is loaded