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

Interface PostPipeline

All Superinterfaces:
AutoCloseable, MutableUniformAccess, org.lwjgl.system.NativeResource, UniformAccess
All Known Implementing Classes:
BlitPostStage, CompositePostPipeline, CopyPostStage, DepthFunctionPostStage, FramebufferPostStage, MaskPostStage
public interface PostPipeline extends MutableUniformAccess, org.lwjgl.system.NativeResource

A series of post-processing effects that can be run to change the current framebuffer state.

It can be fully run using PostProcessingManager.runPipeline(PostPipeline).

This class implements UniformAccess to allow changing uniforms in all shaders.

  • Field Details

    • CODEC

      static final com.mojang.serialization.Codec<PostPipeline> CODEC

  • Method Details

    • apply

      @OverrideOnly void apply(PostPipeline.Context context)
      Applies this post effect. PostProcessingManager.runPipeline(PostPipeline) should be called to run this pipeline.
      Parameters:
      context - The context to use when running this pipeline.

    • free

      default void free()
      Allows a post pipeline to dispose of any resources it takes up.
      Specified by:
      free in interface org.lwjgl.system.NativeResource

    • getType

      PostPipelineStageRegistry.PipelineType<? extends PostPipeline> getType()
      Returns:
      The type of post effect this is

    • getUniformLocation

      default int getUniformLocation(CharSequence name)
      Description copied from interface: UniformAccess
      Retrieves the location of a uniform.
      Specified by:
      getUniformLocation in interface UniformAccess
      Parameters:
      name - The name of the uniform to get
      Returns:
      The location of that uniform or -1 if not found

    • getUniform

      @Nullable default @Nullable ShaderUniformAccess getUniform(CharSequence name)
      Description copied from interface: UniformAccess
      Retrieves a uniform by name.
      Specified by:
      getUniform in interface UniformAccess
      Parameters:
      name - The name of the uniform to get
      Returns:
      The uniform with that name or null if the uniform does not exist

    • getUniformSafe

      default ShaderUniformAccess getUniformSafe(CharSequence name)
      Description copied from interface: UniformAccess
      Retrieves a uniform by name.
      Specified by:
      getUniformSafe in interface UniformAccess
      Parameters:
      name - The name of the uniform to get
      Returns:
      The uniform with that name

    • getOrCreateUniform

      default ShaderUniformAccess getOrCreateUniform(CharSequence name)
      Description copied from interface: UniformAccess
      Retrieves a uniform by name or creates a reference to one that may exist in the future.
      Specified by:
      getOrCreateUniform in interface UniformAccess
      Parameters:
      name - The name of the uniform to get
      Returns:
      The uniform instance

    • getUniformBlock

      default int getUniformBlock(CharSequence name)
      Description copied from interface: UniformAccess
      Retrieves the location of a uniform block.
      Specified by:
      getUniformBlock in interface UniformAccess
      Parameters:
      name - The name of the uniform block to get
      Returns:
      The location of that uniform block or -1 if not found

    • getStorageBlock

      default int getStorageBlock(CharSequence name)
      Description copied from interface: UniformAccess
      Retrieves the location of a storage block.
      Specified by:
      getStorageBlock in interface UniformAccess
      Parameters:
      name - The name of the storage block to get
      Returns:
      The location of that storage block or -1 if not found

    • hasUniform

      default boolean hasUniform(CharSequence name)
      Description copied from interface: UniformAccess
      Checks if the specified uniform exists in the shader.
      Specified by:
      hasUniform in interface UniformAccess
      Parameters:
      name - The name of the uniform to check
      Returns:
      Whether that uniform can be set

    • hasUniformBlock

      default boolean hasUniformBlock(CharSequence name)
      Description copied from interface: UniformAccess
      Checks if the specified uniform block exists in the shader.
      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

      default boolean hasStorageBlock(CharSequence name)
      Description copied from interface: UniformAccess
      Checks if the specified storage block exists in the shader.
      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

      default 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
      Parameters:
      name - The name of the block to set
      binding - The binding to use for that block

    • setStorageBlock

      default 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
      Parameters:
      name - The name of the block to set
      binding - The binding to use for that block