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

Class PostProcessingManager

java.lang.Object
net.minecraft.server.packs.resources.SimplePreparableReloadListener<Map<net.minecraft.resources.ResourceLocation,T>>
foundry.veil.api.CodecReloadListener<CompositePostPipeline>
foundry.veil.api.client.render.post.PostProcessingManager
All Implemented Interfaces:
AutoCloseable, net.minecraft.server.packs.resources.PreparableReloadListener, org.lwjgl.system.NativeResource
public class PostProcessingManager extends CodecReloadListener<CompositePostPipeline> implements org.lwjgl.system.NativeResource

Manages all post pipelines.

Post Pipelines are a single "effect" that can be applied. For example, a vanilla Minecraft creeper effect can be a added using add(int, ResourceLocation)

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    PostProcessingManager.ProfileEntry
    A single active profile.

    Nested classes/interfaces inherited from interface net.minecraft.server.packs.resources.PreparableReloadListener

    net.minecraft.server.packs.resources.PreparableReloadListener.PreparationBarrier

  • Field Summary

    Fields inherited from class foundry.veil.api.CodecReloadListener

    codec, converter

  • Constructor Summary

    Constructors
    Constructor
    Description
    PostProcessingManager()
    Creates a new instance of the post-processing manager.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    add(int priority, net.minecraft.resources.ResourceLocation pipeline)
    Adds the specified pipeline with the specified priority.
    boolean
    add(net.minecraft.resources.ResourceLocation pipeline)
    Adds the specified pipeline under the default priority of 1000.
    protected void
    apply(@NotNull Map<net.minecraft.resources.ResourceLocation,CompositePostPipeline> data, @NotNull net.minecraft.server.packs.resources.ResourceManager resourceManager, @NotNull net.minecraft.util.profiling.ProfilerFiller profilerFiller)
     
    void
    free()
     
    List<PostProcessingManager.ProfileEntry>
    getActivePipelines()
     
    PostPipeline.Context
    getContext()
     
    @Nullable PostPipeline
    getPipeline(net.minecraft.resources.ResourceLocation pipeline)
    Retrieves a post pipeline by name.
    @NotNull Set<net.minecraft.resources.ResourceLocation>
    getPipelines()
     
    boolean
    isActive(net.minecraft.resources.ResourceLocation pipeline)
    Checks to see if the specified pipeline is active.
    protected @NotNull Map<net.minecraft.resources.ResourceLocation,CompositePostPipeline>
    prepare(@NotNull net.minecraft.server.packs.resources.ResourceManager resourceManager, @NotNull net.minecraft.util.profiling.ProfilerFiller profilerFiller)
     
    boolean
    remove(net.minecraft.resources.ResourceLocation pipeline)
    Removes the specified pipeline from the active profiles.
    void
    runPipeline()
     
    void
    runPipeline(PostPipeline pipeline)
    Applies only the specified pipeline.
    void
    runPipeline(PostPipeline pipeline, boolean resolvePost)
    Applies only the specified pipeline.

    Methods inherited from class net.minecraft.server.packs.resources.SimplePreparableReloadListener

    reload

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.lwjgl.system.NativeResource

    close

    Methods inherited from interface net.minecraft.server.packs.resources.PreparableReloadListener

    getName

  • Constructor Details

    • PostProcessingManager

      public PostProcessingManager()
      Creates a new instance of the post-processing manager.

  • Method Details

    • isActive

      public boolean isActive(net.minecraft.resources.ResourceLocation pipeline)
      Checks to see if the specified pipeline is active.
      Parameters:
      pipeline - The pipeline to check for
      Returns:
      Whether that pipeline is active

    • add

      public boolean add(net.minecraft.resources.ResourceLocation pipeline)
      Adds the specified pipeline under the default priority of 1000. A higher priority indicates the pipeline should be run earlier than lower priority pipelines.
      Parameters:
      pipeline - The pipeline to add
      Returns:
      Whether the pipeline was added or had a priority change

    • add

      public boolean add(int priority, net.minecraft.resources.ResourceLocation pipeline)
      Adds the specified pipeline with the specified priority. A higher priority indicates the pipeline should be run earlier than lower priority pipelines.
      Parameters:
      priority - The priority to set the pipeline to. The default priority is 1000
      pipeline - The pipeline to add
      Returns:
      Whether the pipeline was added or had a priority change

    • remove

      public boolean remove(net.minecraft.resources.ResourceLocation pipeline)
      Removes the specified pipeline from the active profiles.
      Parameters:
      pipeline - The pipeline to remove
      Returns:
      If the pipeline was previously active

    • getPipeline

      @Nullable public @Nullable PostPipeline getPipeline(net.minecraft.resources.ResourceLocation pipeline)
      Retrieves a post pipeline by name.
      Parameters:
      pipeline - The pipeline to get
      Returns:
      The pipeline found or null if it doesn't exist

    • runPipeline

      @Internal public void runPipeline()

    • runPipeline

      public void runPipeline(PostPipeline pipeline)
      Applies only the specified pipeline. Copies the main buffer into the post framebuffer and back before running the pipeline.
      Parameters:
      pipeline - The pipeline to run

    • runPipeline

      public void runPipeline(PostPipeline pipeline, boolean resolvePost)
      Applies only the specified pipeline.
      Parameters:
      pipeline - The pipeline to run
      resolvePost - Whether to copy the main buffer into the post framebuffer before running the pipeline

    • prepare

      @NotNull protected @NotNull Map<net.minecraft.resources.ResourceLocation,CompositePostPipeline> prepare(@NotNull @NotNull net.minecraft.server.packs.resources.ResourceManager resourceManager, @NotNull @NotNull net.minecraft.util.profiling.ProfilerFiller profilerFiller)
      Overrides:
      prepare in class CodecReloadListener<CompositePostPipeline>

    • apply

      protected void apply(@NotNull @NotNull Map<net.minecraft.resources.ResourceLocation,CompositePostPipeline> data, @NotNull @NotNull net.minecraft.server.packs.resources.ResourceManager resourceManager, @NotNull @NotNull net.minecraft.util.profiling.ProfilerFiller profilerFiller)
      Specified by:
      apply in class net.minecraft.server.packs.resources.SimplePreparableReloadListener<Map<net.minecraft.resources.ResourceLocation,CompositePostPipeline>>

    • free

      public void free()
      Specified by:
      free in interface org.lwjgl.system.NativeResource

    • getContext

      public PostPipeline.Context getContext()
      Returns:
      The default context for post-processing

    • getPipelines

      @NotNull public @NotNull Set<net.minecraft.resources.ResourceLocation> getPipelines()
      Returns:
      All available pipelines

    • getActivePipelines

      public List<PostProcessingManager.ProfileEntry> getActivePipelines()
      Returns:
      An immutable view of all active profiles and their priorities