Package foundry.veil.api.client.render.post.stage

Class CompositePostPipeline

java.lang.Object

foundry.veil.api.client.render.post.stage.CompositePostPipeline

All Implemented Interfaces:

PostPipeline, MutableUniformAccess, UniformAccess, AutoCloseable, org.lwjgl.system.NativeResource

public class CompositePostPipeline
extends Object
implements PostPipeline

A pipeline that runs all child pipelines in order.

Nested Class Summary

Nested classes/interfaces inherited from interface foundry.veil.api.client.render.post.PostPipeline

PostPipeline.Context

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<CompositePostPipeline>	CODEC

Constructor Summary

Constructors

Constructor	Description
CompositePostPipeline(PostPipeline[] stages, Map<String,ShaderTextureSource> textures, Map<net.minecraft.resources.ResourceLocation,FramebufferDefinition> framebufferDefinitions)	Creates a new composite post pipeline that runs all child pipelines in order.

Method Summary

Modifier and Type	Method	Description
void	apply(PostPipeline.Context context)	Applies this post effect.
void	free()	Allows a post pipeline to dispose of any resources it takes up.
Map<net.minecraft.resources.ResourceLocation,FramebufferDefinition>	getFramebuffers()
int	getPriority()
PostPipeline[]	getStages()
Map<String,ShaderTextureSource>	getTextures()
PostPipelineStageRegistry.PipelineType<? extends PostPipeline>	getType()
boolean	hasStorageBlock(CharSequence name)	Checks if the specified storage block exists in the shader.
boolean	hasUniform(CharSequence name)	Checks if the specified uniform exists in the shader.
boolean	hasUniformBlock(CharSequence name)	Checks if the specified uniform block exists in the shader.
boolean	isReplace()
void	setFloat(CharSequence name, float value)	Sets a float in the shader.
void	setFloats(CharSequence name, float... values)	Sets an array of floats in the shader.
void	setInt(CharSequence name, int value)	Sets an integer in the shader.
void	setInts(CharSequence name, int... values)	Sets an array of integers in the shader.
void	setMatrix(CharSequence name, org.joml.Matrix2fc value)	Sets a matrix in the shader.
void	setMatrix(CharSequence name, org.joml.Matrix3fc value)	Sets a matrix in the shader.
void	setMatrix(CharSequence name, org.joml.Matrix3x2fc value)	Sets a matrix in the shader.
void	setMatrix(CharSequence name, org.joml.Matrix4fc value)	Sets a matrix in the shader.
void	setMatrix(CharSequence name, org.joml.Matrix4x3fc value)	Sets a matrix in the shader.
void	setStorageBlock(CharSequence name, int binding)	Sets the binding to use for the specified storage block.
void	setUniformBlock(CharSequence name, int binding)	Sets the binding to use for the specified uniform block.
void	setVector(CharSequence name, float x, float y)	Sets a vector in the shader.
void	setVector(CharSequence name, float x, float y, float z)	Sets a vector in the shader.
void	setVector(CharSequence name, float x, float y, float z, float w)	Sets a vector in the shader.
void	setVectorI(CharSequence name, int x, int y)	Sets an integer vector in the shader.
void	setVectorI(CharSequence name, int x, int y, int z)	Sets an integer vector in the shader.
void	setVectorI(CharSequence name, int x, int y, int z, int w)	Sets an integer vector in the shader.
void	setVectors(CharSequence name, org.joml.Vector2fc... values)	Sets an array of vectors in the shader.
void	setVectors(CharSequence name, org.joml.Vector2ic... values)	Sets an array of integer vectors in the shader.
void	setVectors(CharSequence name, org.joml.Vector3fc... values)	Sets an array of vectors in the shader.
void	setVectors(CharSequence name, org.joml.Vector3ic... values)	Sets an array of integer vectors in the shader.
void	setVectors(CharSequence name, org.joml.Vector4fc... values)	Sets an array of vectors in the shader.
void	setVectors(CharSequence name, org.joml.Vector4ic... values)	Sets an array of integer vectors in the shader.

Methods inherited from class java.lang.Object

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

Methods inherited from interface foundry.veil.api.client.render.shader.program.MutableUniformAccess

applyRenderSystem, setVector, setVector, setVector, setVector, setVectorI, setVectorI, setVectorI

Methods inherited from interface org.lwjgl.system.NativeResource

close

Methods inherited from interface foundry.veil.api.client.render.post.PostPipeline

getFloat, getFloats, getInt, getInts, getMatrix, getMatrix, getMatrix, getMatrix, getMatrix, getStorageBlock, getUniform, getUniformBlock, getVector, getVector, getVector, getVector, getVector, getVector

Field Details

CODEC

public static final com.mojang.serialization.Codec<CompositePostPipeline> CODEC

Constructor Details

CompositePostPipeline

public CompositePostPipeline(PostPipeline[] stages,
 Map<String,ShaderTextureSource> textures,
 Map<net.minecraft.resources.ResourceLocation,FramebufferDefinition> framebufferDefinitions)

Creates a new composite post pipeline that runs all child pipelines in order.

Parameters:

stages - The pipelines to run in order

textures - The textures to bind globally

framebufferDefinitions - The definitions of framebuffers to create for use in the stages

Method Details

apply

public void apply(PostPipeline.Context context)

Description copied from interface: PostPipeline

Applies this post effect. PostProcessingManager.runPipeline(PostPipeline) should be called to run this pipeline.

Specified by:

apply in interface PostPipeline

Parameters:

context - The context to use when running this pipeline.

free

public void free()

Description copied from interface: PostPipeline

Allows a post pipeline to dispose of any resources it takes up.

Specified by:

free in interface org.lwjgl.system.NativeResource

Specified by:

free in interface PostPipeline

getType

public PostPipelineStageRegistry.PipelineType<? extends PostPipeline> getType()

Specified by:

getType in interface PostPipeline

Returns:

The type of post effect this is

hasUniform

public boolean hasUniform(CharSequence name)

Description copied from interface: UniformAccess

Checks if the specified uniform exists in the shader.

Specified by:

hasUniform in interface PostPipeline

Specified by:

hasUniform in interface UniformAccess

Parameters:

name - The name of the uniform to check

Returns:

Whether that uniform can be set

hasUniformBlock

public boolean hasUniformBlock(CharSequence name)

Description copied from interface: UniformAccess

Checks if the specified uniform block exists in the shader.

Specified by:

hasUniformBlock in interface PostPipeline

Specified by:

hasUniformBlock in interface UniformAccess

Parameters:

name - The name of the uniform block to check

Returns:

Whether that uniform block can be set

hasStorageBlock

public boolean hasStorageBlock(CharSequence name)

Description copied from interface: UniformAccess

Checks if the specified storage block exists in the shader.

Specified by:

hasStorageBlock in interface PostPipeline

Specified by:

hasStorageBlock in interface UniformAccess

Parameters:

name - The name of the storage block to check

Returns:

Whether that storage block can be set

setUniformBlock

public void setUniformBlock(CharSequence name,
 int binding)

Description copied from interface: MutableUniformAccess

Sets the binding to use for the specified uniform block.

Specified by:

setUniformBlock in interface MutableUniformAccess

Specified by:

setUniformBlock in interface PostPipeline

Parameters:

name - The name of the block to set

binding - The binding to use for that block

setStorageBlock

public void setStorageBlock(CharSequence name,
 int binding)

Description copied from interface: MutableUniformAccess

Sets the binding to use for the specified storage block.

Specified by:

setStorageBlock in interface MutableUniformAccess

Specified by:

setStorageBlock in interface PostPipeline

Parameters:

name - The name of the block to set

binding - The binding to use for that block

setFloat

public void setFloat(CharSequence name,
 float value)

Description copied from interface: MutableUniformAccess

Sets a float in the shader.

Specified by:

setFloat in interface MutableUniformAccess

Specified by:

setFloat in interface PostPipeline

Parameters:

name - The name of the uniform to set

value - The value to set

setVector

public void setVector(CharSequence name,
 float x,
 float y)

Description copied from interface: MutableUniformAccess

Sets a vector in the shader.

Specified by:

setVector in interface MutableUniformAccess

Specified by:

setVector in interface PostPipeline

Parameters:

name - The name of the uniform to set

x - The x component of the vector

y - The y component of the vector

setVector

public void setVector(CharSequence name,
 float x,
 float y,
 float z)

Description copied from interface: MutableUniformAccess

Sets a vector in the shader.

Specified by:

setVector in interface MutableUniformAccess

Specified by:

setVector in interface PostPipeline

Parameters:

name - The name of the uniform to set

x - The x component of the vector

y - The y component of the vector

z - The z component of the vector

setVector

public void setVector(CharSequence name,
 float x,
 float y,
 float z,
 float w)

Description copied from interface: MutableUniformAccess

Sets a vector in the shader.

Specified by:

setVector in interface MutableUniformAccess

Specified by:

setVector in interface PostPipeline

Parameters:

name - The name of the uniform to set

x - The x component of the vector

y - The y component of the vector

z - The z component of the vector

w - The w component of the vector

setInt

public void setInt(CharSequence name,
 int value)

Description copied from interface: MutableUniformAccess

Sets an integer in the shader.

Specified by:

setInt in interface MutableUniformAccess

Specified by:

setInt in interface PostPipeline

Parameters:

name - The name of the uniform to set

value - The value to set

setVectorI

public void setVectorI(CharSequence name,
 int x,
 int y)

Description copied from interface: MutableUniformAccess

Sets an integer vector in the shader.

Specified by:

setVectorI in interface MutableUniformAccess

Specified by:

setVectorI in interface PostPipeline

Parameters:

name - The name of the uniform to set

x - The x component of the vector

y - The y component of the vector

setVectorI

public void setVectorI(CharSequence name,
 int x,
 int y,
 int z)

Description copied from interface: MutableUniformAccess

Sets an integer vector in the shader.

Specified by:

setVectorI in interface MutableUniformAccess

Specified by:

setVectorI in interface PostPipeline

Parameters:

name - The name of the uniform to set

x - The x component of the vector

y - The y component of the vector

z - The z component of the vector

setVectorI

public void setVectorI(CharSequence name,
 int x,
 int y,
 int z,
 int w)

Description copied from interface: MutableUniformAccess

Sets an integer vector in the shader.

Specified by:

setVectorI in interface MutableUniformAccess

Specified by:

setVectorI in interface PostPipeline

Parameters:

name - The name of the uniform to set

x - The x component of the vector

y - The y component of the vector

z - The z component of the vector

w - The w component of the vector

setFloats

public void setFloats(CharSequence name,
 float... values)

Description copied from interface: MutableUniformAccess

Sets an array of floats in the shader.

Specified by:

setFloats in interface MutableUniformAccess

Specified by:

setFloats in interface PostPipeline

Parameters:

name - The name of the uniform to set

values - The values to set in order

setVectors

public void setVectors(CharSequence name,
 org.joml.Vector2fc... values)

Description copied from interface: MutableUniformAccess

Sets an array of vectors in the shader.

Specified by:

setVectors in interface MutableUniformAccess

Specified by:

setVectors in interface PostPipeline

Parameters:

name - The name of the uniform to set

values - The values to set in order

setVectors

public void setVectors(CharSequence name,
 org.joml.Vector3fc... values)

Description copied from interface: MutableUniformAccess

Sets an array of vectors in the shader.

Specified by:

setVectors in interface MutableUniformAccess

Specified by:

setVectors in interface PostPipeline

Parameters:

name - The name of the uniform to set

values - The values to set in order

setVectors

public void setVectors(CharSequence name,
 org.joml.Vector4fc... values)

Description copied from interface: MutableUniformAccess

Sets an array of vectors in the shader.

Specified by:

setVectors in interface MutableUniformAccess

Specified by:

setVectors in interface PostPipeline

Parameters:

name - The name of the uniform to set

values - The values to set in order

setInts

public void setInts(CharSequence name,
 int... values)

Description copied from interface: MutableUniformAccess

Sets an array of integers in the shader.

Specified by:

setInts in interface MutableUniformAccess

Specified by:

setInts in interface PostPipeline

Parameters:

name - The name of the uniform to set

values - The values to set in order

setVectors

public void setVectors(CharSequence name,
 org.joml.Vector2ic... values)

Description copied from interface: MutableUniformAccess

Sets an array of integer vectors in the shader.

Specified by:

setVectors in interface MutableUniformAccess

Specified by:

setVectors in interface PostPipeline

Parameters:

name - The name of the uniform to set

values - The values to set in order

setVectors

public void setVectors(CharSequence name,
 org.joml.Vector3ic... values)

Description copied from interface: MutableUniformAccess

Sets an array of integer vectors in the shader.

Specified by:

setVectors in interface MutableUniformAccess

Specified by:

setVectors in interface PostPipeline

Parameters:

name - The name of the uniform to set

values - The values to set in order

setVectors

public void setVectors(CharSequence name,
 org.joml.Vector4ic... values)

Description copied from interface: MutableUniformAccess

Sets an array of integer vectors in the shader.

Specified by:

setVectors in interface MutableUniformAccess

Specified by:

setVectors in interface PostPipeline

Parameters:

name - The name of the uniform to set

values - The values to set in order

setMatrix

public void setMatrix(CharSequence name,
 org.joml.Matrix2fc value)

Description copied from interface: MutableUniformAccess

Sets a matrix in the shader.

Specified by:

setMatrix in interface MutableUniformAccess

Specified by:

setMatrix in interface PostPipeline

Parameters:

name - The name of the uniform to set

value - The value to set

setMatrix

public void setMatrix(CharSequence name,
 org.joml.Matrix3fc value)

Description copied from interface: MutableUniformAccess

Sets a matrix in the shader.

Specified by:

setMatrix in interface MutableUniformAccess

Specified by:

setMatrix in interface PostPipeline

Parameters:

name - The name of the uniform to set

value - The value to set

setMatrix

public void setMatrix(CharSequence name,
 org.joml.Matrix3x2fc value)

Description copied from interface: MutableUniformAccess

Sets a matrix in the shader.

Specified by:

setMatrix in interface MutableUniformAccess

Specified by:

setMatrix in interface PostPipeline

Parameters:

name - The name of the uniform to set

value - The value to set

setMatrix

public void setMatrix(CharSequence name,
 org.joml.Matrix4fc value)

Description copied from interface: MutableUniformAccess

Sets a matrix in the shader.

Specified by:

setMatrix in interface MutableUniformAccess

Specified by:

setMatrix in interface PostPipeline

Parameters:

name - The name of the uniform to set

value - The value to set

setMatrix

public void setMatrix(CharSequence name,
 org.joml.Matrix4x3fc value)

Description copied from interface: MutableUniformAccess

Sets a matrix in the shader.

Specified by:

setMatrix in interface MutableUniformAccess

Specified by:

setMatrix in interface PostPipeline

Parameters:

name - The name of the uniform to set

value - The value to set

getStages

public PostPipeline[] getStages()

Returns:

The stages run in this pipeline

getTextures

public Map<String,ShaderTextureSource> getTextures()

Returns:

The globally bound textures for the child stages to access

getFramebuffers

public Map<net.minecraft.resources.ResourceLocation,FramebufferDefinition> getFramebuffers()

Returns:

The framebuffers created for the child stages to access

getPriority

public int getPriority()

Returns:

The priority of this pipeline

isReplace

public boolean isReplace()

Returns:

Whether this stage will replace all stages with a higher priority