Package net.ixdarklord.coolcatcanvas.api.client.effect

Interface ScreenEffect

All Known Implementing Classes:
ScreenEffectImpl
public interface ScreenEffect
A full-screen post-processing effect, made with ScreenEffects.register(net.minecraft.resources.ResourceLocation, net.minecraft.resources.ResourceLocation). Effects start disabled; any number can be active at once, drawn within their scope in layer order.

An effect's drawn strength, from 0 to 1, is the product of:

A strength of 0 skips the effect entirely. Shaders read it as Strength from #moj_import <coolcatcanvas:screen_effect.glsl>, and should scale their work by it; autoBlend(boolean) does that for shaders that don't.

Durations are in ticks of real time (20 per second), so effects keep animating while the game is paused. Only use an effect from the render thread.

  • Method Details

    • id

      net.minecraft.resources.ResourceLocation id()

    • definitionId

      @Nullable @Nullable net.minecraft.resources.ResourceLocation definitionId()
      The post chain JSON it's loaded from (shaders/post/<path>.json), or null for a definition built in code.

    • displayName

      net.minecraft.network.chat.Component displayName()
      The name shown in the effects screen: by default screen_effect.<namespace>.<path>, else the path.

    • displayName

      ScreenEffect displayName(net.minecraft.network.chat.Component name)

    • description

      @Nullable @Nullable net.minecraft.network.chat.Component description()
      A line or two shown in the effects screen, or null.

    • description

      ScreenEffect description(@Nullable @Nullable net.minecraft.network.chat.Component description)

    • isSelectable

      boolean isSelectable()
      Whether players can turn it on and off from the effects screen, where their choice is remembered. True by default; turn it off for effects the mod drives on its own (an effect with an activeWhen(java.util.function.Predicate<net.ixdarklord.coolcatcanvas.api.client.effect.EffectContext>) condition is listed but can't be toggled there).

    • selectable

      ScreenEffect selectable(boolean selectable)

    • scope

      ScreenEffectScope scope()

    • scope

      ScreenEffect scope(ScreenEffectScope scope)
      Where in the frame it's drawn. Defaults to ScreenEffectScope.WORLD.

    • priority

      int priority()

    • priority

      ScreenEffect priority(int priority)
      Where the effect starts in the layer order: lower priorities are drawn first, so later effects process their output. Defaults to 0. Once the order is rearranged (by code or by a player), it's kept until ScreenEffectLayers.resetOrder().

    • isAutomatic

      boolean isAutomatic()
      Whether it has an activeWhen(java.util.function.Predicate<net.ixdarklord.coolcatcanvas.api.client.effect.EffectContext>) condition deciding when it's on.

    • fade

      ScreenEffect fade(int fadeInTicks, int fadeOutTicks, Easing easing)
      How it fades in and out. Both default to 10 ticks with Easing.SINE_IN_OUT.

    • fade

      default ScreenEffect fade(int ticks)

    • autoBlend

      ScreenEffect autoBlend(boolean autoBlend)
      Blends the effect's output with the unprocessed image by its strength, so any shader fades smoothly, including vanilla-style ones that ignore Strength. Costs three extra full-screen copies. Off by default.

    • activeWhen

      ScreenEffect activeWhen(@Nullable @Nullable Predicate<EffectContext> condition)
      Enables the effect when the condition starts holding and disables it when it stops, checked every frame. In between, the effect can still be toggled by hand (or vetoed through ScreenEffectEvents.BEFORE_TOGGLE), and stays so until the condition changes again. Pass null to stop.

    • strength

      ScreenEffect strength(@Nullable EffectContext.StrengthFunction function)
      Scales the strength by a function of the frame, clamped to [0, 1]; null to stop.

    • onFrame

      ScreenEffect onFrame(@Nullable @Nullable Consumer<EffectContext> callback)
      Runs every frame before drawing, while the effect is visible: a place to drive uniforms.

    • enable

      ScreenEffect enable()
      Fades in, or keeps the effect on if it's already. Cancels a pending enableFor(int) timeout.

    • disable

      ScreenEffect disable()
      Fades out.

    • setEnabled

      default ScreenEffect setEnabled(boolean enabled)

    • toggle

      default ScreenEffect toggle()

    • enableFor

      ScreenEffect enableFor(int ticks)
      Fades in, stays for ticks, then fades out: a flash, a pulse, a hit.

    • enableInstantly

      ScreenEffect enableInstantly()
      Shows the effect at full fade right away, skipping the fade-in.

    • disableInstantly

      ScreenEffect disableInstantly()
      Hides the effect right away, skipping the fade-out.

    • isEnabled

      boolean isEnabled()
      Whether it's enabled; it may still be fading in.

    • isVisible

      boolean isVisible()
      Whether it's drawn this frame: enabled or still fading out, with a strength above 0.

    • setStrength

      ScreenEffect setStrength(float strength)
      Sets the manual strength, clamped to [0, 1].

    • animateStrength

      ScreenEffect animateStrength(float target, int ticks, Easing easing)
      Moves the manual strength to target over ticks.

    • strength

      float strength()
      The strength the effect is drawn with this frame.

    • uniform

      EffectUniform uniform(String name)
      The uniform named name in any of its passes' programs.

    • setUniform

      default ScreenEffect setUniform(String name, float... values)

    • setUniformInt

      default ScreenEffect setUniformInt(String name, int... values)

    • bindUniform

      default ScreenEffect bindUniform(String name, EffectUniform.FloatBinding binding)

    • bindUniform

      default ScreenEffect bindUniform(String name, EffectUniform.VectorBinding binding)

    • resetUniforms

      ScreenEffect resetUniforms()
      Resets every uniform to its definition's default.

    • isLoaded

      boolean isLoaded()
      Whether its shaders compiled and it can be drawn. False until the first resource load, and after errors.

    • error

      @Nullable @Nullable String error()
      Why it failed to load or draw, if it did. Fixed by a resource reload.