Package dev.cammiescorner.velvet.impl

Class ResettableManagedShaderEffect

java.lang.Object

dev.cammiescorner.velvet.impl.ResettableManagedShaderBase<net.minecraft.client.renderer.PostChain>

dev.cammiescorner.velvet.impl.ResettableManagedShaderEffect

All Implemented Interfaces:

ManagedShaderEffect, UniformFinder

public final class ResettableManagedShaderEffect
extends ResettableManagedShaderBase<net.minecraft.client.renderer.PostChain>
implements ManagedShaderEffect

A ManagedShaderEffect that can be setup(int, int) several times in its lifetime, triggering an initialization callback.

Since:

1.0.0

See Also:

• ReloadableShaderEffectManager
• ManagedShaderEffect

Field Summary

Fields inherited from class dev.cammiescorner.velvet.impl.ResettableManagedShaderBase

shader

Constructor Summary

Constructors

Constructor	Description
ResettableManagedShaderEffect(net.minecraft.resources.ResourceLocation location, Consumer<ManagedShaderEffect> initCallback)	Creates a new shader effect.

Method Summary

Modifier and Type	Method	Description
SamplerUniformV2	findSampler(String samplerName)	Finds a sampler declared in json
@Nullable net.minecraft.client.renderer.PostChain	getShaderEffect()	Returns this object's managed PostChain, creating and initializing it if it doesn't exist.
ManagedRenderTarget	getTarget(String name)
void	initialize()	Initializes this shader, allocating required system resources such as render target objects, shaders objects and texture objects.
protected void	logInitError(IOException e)
protected net.minecraft.client.renderer.PostChain	parseShader(net.minecraft.server.packs.resources.ResourceProvider resourceFactory, net.minecraft.client.Minecraft mc, net.minecraft.resources.ResourceLocation location)
void	render(float tickDelta)	Renders this shader.
void	setSamplerUniform(String samplerName, int textureName)	Sets the value of a sampler uniform declared in json
void	setSamplerUniform(String samplerName, com.mojang.blaze3d.pipeline.RenderTarget textureFbo)	Sets the value of a sampler uniform declared in json
void	setSamplerUniform(String samplerName, net.minecraft.client.renderer.texture.AbstractTexture texture)	Sets the value of a sampler uniform declared in json
void	setUniformValue(String uniformName, float value)	Sets the value of a uniform declared in json
void	setUniformValue(String uniformName, float value0, float value1)	Sets the value of a uniform declared in json
void	setUniformValue(String uniformName, float value0, float value1, float value2)	Sets the value of a uniform declared in json
void	setUniformValue(String uniformName, float value0, float value1, float value2, float value3)	Sets the value of a uniform declared in json
void	setUniformValue(String uniformName, int value)	Sets the value of a uniform declared in json
void	setUniformValue(String uniformName, int value0, int value1)	Sets the value of a uniform declared in json
void	setUniformValue(String uniformName, int value0, int value1, int value2)	Sets the value of a uniform declared in json
void	setUniformValue(String uniformName, int value0, int value1, int value2, int value3)	Sets the value of a uniform declared in json
void	setUniformValue(String uniformName, org.joml.Matrix4f value)	Sets the value of a uniform declared in json
void	setup(int windowWidth, int windowHeight)
void	setupDynamicUniforms(int index, Runnable dynamicSetBlock)	Runs the given block while the shader at the given index is active
void	setupDynamicUniforms(Runnable dynamicSetBlock)	Forwards to ManagedShaderEffect.setupDynamicUniforms(int, Runnable) with an index of 0
protected boolean	setupUniform(ManagedUniformBase uniform, net.minecraft.client.renderer.PostChain shader)

Methods inherited from class dev.cammiescorner.velvet.impl.ResettableManagedShaderBase

findUniform1f, findUniform1i, findUniform2f, findUniform2i, findUniform3f, findUniform3i, findUniform4f, findUniform4i, findUniformMat4, getLocation, getManagedUniforms, initialize, initializeOrLog, isErrored, isInitialized, manageUniform, release, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.cammiescorner.velvet.api.managed.ManagedShaderEffect

isErrored, isInitialized, release

Methods inherited from interface dev.cammiescorner.velvet.api.managed.uniform.UniformFinder

findUniform1f, findUniform1i, findUniform2f, findUniform2i, findUniform3f, findUniform3i, findUniform4f, findUniform4i, findUniformMat4

Constructor Details

ResettableManagedShaderEffect

@API(status=INTERNAL)
public ResettableManagedShaderEffect(net.minecraft.resources.ResourceLocation location,
 Consumer<ManagedShaderEffect> initCallback)

Creates a new shader effect.
Users should obtain instanced of this class through ShaderEffectManager

Parameters:

location - the location of a shader effect JSON definition file

initCallback - code to run in setup(int, int)

See Also:

• ReloadableShaderEffectManager.manage(ResourceLocation)
• ReloadableShaderEffectManager.manage(ResourceLocation, Consumer)

Method Details

getShaderEffect

@Nullable
public @Nullable net.minecraft.client.renderer.PostChain getShaderEffect()

Description copied from interface: ManagedShaderEffect

Returns this object's managed PostChain, creating and initializing it if it doesn't exist.

This method will return null if an error occurs during initialization.

Note: calling this before the graphic context is ready will cause issues.

Specified by:

getShaderEffect in interface ManagedShaderEffect

Returns:

the PostChain managed by this object

See Also:

• ManagedShaderEffect.initialize()
• ManagedShaderEffect.isInitialized()

initialize

public void initialize()
                throws IOException

Description copied from interface: ManagedShaderEffect

Initializes this shader, allocating required system resources such as render target objects, shaders objects and texture objects. Any exception thrown during initialization is relayed to the caller.

If the shader is already initialized, previously allocated resources will be disposed of before initializing new ones.

Specified by:

initialize in interface ManagedShaderEffect

Throws:

IOException

See Also:

• ManagedShaderEffect.getShaderEffect()
• ManagedShaderEffect.isInitialized()
• ManagedShaderEffect.release()

parseShader

protected net.minecraft.client.renderer.PostChain parseShader(net.minecraft.server.packs.resources.ResourceProvider resourceFactory,
 net.minecraft.client.Minecraft mc,
 net.minecraft.resources.ResourceLocation location)
                                                       throws IOException

Specified by:

parseShader in class ResettableManagedShaderBase<net.minecraft.client.renderer.PostChain>

Throws:

IOException

setup

public void setup(int windowWidth,
 int windowHeight)

Specified by:

setup in class ResettableManagedShaderBase<net.minecraft.client.renderer.PostChain>

render

public void render(float tickDelta)

Renders this shader.

Calling this method first setups the graphic state for rendering, then uploads uniforms to the GPU if they have been changed since last draw, draws the main render target's texture to intermediate render targets as defined by the JSON files and resets part of the graphic state. The shader will be initialized if it has not been before.

This method should be called every frame when the shader is active. Uniforms should be set before rendering.

Specified by:

render in interface ManagedShaderEffect

getTarget

public ManagedRenderTarget getTarget(String name)

Specified by:

getTarget in interface ManagedShaderEffect

setUniformValue

public void setUniformValue(String uniformName,
 int value)

Sets the value of a uniform declared in json

Specified by:

setUniformValue in interface ManagedShaderEffect

Parameters:

uniformName - the name of the uniform field in the shader source file

value - int value

See Also:

• UniformFinder.findUniform1i(String)
• Uniform1i.set(int)

setUniformValue

public void setUniformValue(String uniformName,
 int value0,
 int value1)

Sets the value of a uniform declared in json

Specified by:

setUniformValue in interface ManagedShaderEffect

Parameters:

uniformName - the name of the uniform field in the shader source file

value0 - int value

value1 - int value

See Also:

• UniformFinder.findUniform2i(String)
• Uniform2i.set(int, int)

setUniformValue

public void setUniformValue(String uniformName,
 int value0,
 int value1,
 int value2)

Sets the value of a uniform declared in json

Specified by:

setUniformValue in interface ManagedShaderEffect

Parameters:

uniformName - the name of the uniform field in the shader source file

value0 - int value

value1 - int value

value2 - int value

See Also:

• UniformFinder.findUniform3i(String)
• Uniform3i.set(int, int, int)

setUniformValue

public void setUniformValue(String uniformName,
 int value0,
 int value1,
 int value2,
 int value3)

Sets the value of a uniform declared in json

Specified by:

setUniformValue in interface ManagedShaderEffect

Parameters:

uniformName - the name of the uniform field in the shader source file

value0 - int value

value1 - int value

value2 - int value

value3 - int value

See Also:

• UniformFinder.findUniform4i(String)
• Uniform4i.set(int, int, int, int)

setUniformValue

public void setUniformValue(String uniformName,
 float value)

Sets the value of a uniform declared in json

Specified by:

setUniformValue in interface ManagedShaderEffect

Parameters:

uniformName - the name of the uniform field in the shader source file

value - float value

See Also:

• UniformFinder.findUniform1f(String)
• Uniform1f.set(float)

setUniformValue

public void setUniformValue(String uniformName,
 float value0,
 float value1)

Sets the value of a uniform declared in json

Specified by:

setUniformValue in interface ManagedShaderEffect

Parameters:

uniformName - the name of the uniform field in the shader source file

value0 - float value

value1 - float value

See Also:

• UniformFinder.findUniform2f(String)
• Uniform2f.set(float, float)

setUniformValue

public void setUniformValue(String uniformName,
 float value0,
 float value1,
 float value2)

Sets the value of a uniform declared in json

Specified by:

setUniformValue in interface ManagedShaderEffect

Parameters:

uniformName - the name of the uniform field in the shader source file

value0 - float value

value1 - float value

value2 - float value

See Also:

• UniformFinder.findUniform3f(String)
• Uniform3f.set(float, float, float)

setUniformValue

public void setUniformValue(String uniformName,
 float value0,
 float value1,
 float value2,
 float value3)

Sets the value of a uniform declared in json

Specified by:

setUniformValue in interface ManagedShaderEffect

Parameters:

uniformName - the name of the uniform field in the shader source file

value0 - float value

value1 - float value

value2 - float value

value3 - float value

See Also:

• UniformFinder.findUniform4f(String)
• Uniform4f.set(float, float, float, float)

setUniformValue

public void setUniformValue(String uniformName,
 org.joml.Matrix4f value)

Sets the value of a uniform declared in json

Specified by:

setUniformValue in interface ManagedShaderEffect

Parameters:

uniformName - the name of the uniform field in the shader source file

value - a matrix

See Also:

• UniformFinder.findUniformMat4(String)
• UniformMat4.set(Matrix4f)

setSamplerUniform

public void setSamplerUniform(String samplerName,
 net.minecraft.client.renderer.texture.AbstractTexture texture)

Sets the value of a sampler uniform declared in json

Specified by:

setSamplerUniform in interface ManagedShaderEffect

Parameters:

samplerName - the name of the sampler uniform field in the shader source file and json

texture - a texture object

See Also:

• ManagedShaderEffect.findSampler(String)
• SamplerUniform.set(AbstractTexture)

setSamplerUniform

public void setSamplerUniform(String samplerName,
 com.mojang.blaze3d.pipeline.RenderTarget textureFbo)

Sets the value of a sampler uniform declared in json

Specified by:

setSamplerUniform in interface ManagedShaderEffect

Parameters:

samplerName - the name of the sampler uniform field in the shader source file and json

textureFbo - a render target which main texture will be used

See Also:

• ManagedShaderEffect.findSampler(String)
• SamplerUniform.set(RenderTarget)

setSamplerUniform

public void setSamplerUniform(String samplerName,
 int textureName)

Sets the value of a sampler uniform declared in json

Specified by:

setSamplerUniform in interface ManagedShaderEffect

Parameters:

samplerName - the name of the sampler uniform field in the shader source file and json

textureName - an opengl texture name

See Also:

• ManagedShaderEffect.findSampler(String)
• SamplerUniform.set(int)

findSampler

public SamplerUniformV2 findSampler(String samplerName)

Description copied from interface: UniformFinder

Finds a sampler declared in json

Specified by:

findSampler in interface ManagedShaderEffect

Specified by:

findSampler in interface UniformFinder

Parameters:

samplerName - the name of the sampler field in the shader source file

setupDynamicUniforms

public void setupDynamicUniforms(Runnable dynamicSetBlock)

Description copied from interface: ManagedShaderEffect

Forwards to ManagedShaderEffect.setupDynamicUniforms(int, Runnable) with an index of 0

Specified by:

setupDynamicUniforms in interface ManagedShaderEffect

Parameters:

dynamicSetBlock - a block in which dynamic uniforms are set

setupDynamicUniforms

public void setupDynamicUniforms(int index,
 Runnable dynamicSetBlock)

Description copied from interface: ManagedShaderEffect

Runs the given block while the shader at the given index is active

Specified by:

setupDynamicUniforms in interface ManagedShaderEffect

Parameters:

index - the shader index within the group

dynamicSetBlock - a block in which dynamic name uniforms are set

setupUniform

protected boolean setupUniform(ManagedUniformBase uniform,
 net.minecraft.client.renderer.PostChain shader)

Specified by:

setupUniform in class ResettableManagedShaderBase<net.minecraft.client.renderer.PostChain>

logInitError

protected void logInitError(IOException e)

Specified by:

logInitError in class ResettableManagedShaderBase<net.minecraft.client.renderer.PostChain>