Package net.ixdarklord.coolcatcanvas.internal.client.effect

Class ScreenEffectImpl

java.lang.Object

net.ixdarklord.coolcatcanvas.internal.client.effect.ScreenEffectImpl

All Implemented Interfaces:

ScreenEffect

public final class ScreenEffectImpl
extends Object
implements ScreenEffect

Method Summary

Modifier and Type	Method	Description
ScreenEffect	activeWhen(@Nullable Predicate<EffectContext> condition)	Enables the effect when the condition starts holding and disables it when it stops, checked every frame.
ScreenEffect	animateStrength(float target, int ticks, Easing easing)	Moves the manual strength to target over ticks.
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.
@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.
@Nullable net.minecraft.network.chat.Component	description()	A line or two shown in the effects screen, or null.
ScreenEffect	description(@Nullable net.minecraft.network.chat.Component description)
ScreenEffect	disable()	Fades out.
ScreenEffect	disableInstantly()	Hides the effect right away, skipping the fade-out.
net.minecraft.network.chat.Component	displayName()	The name shown in the effects screen: by default screen_effect.<namespace>.<path>, else the path.
ScreenEffect	displayName(net.minecraft.network.chat.Component name)
ScreenEffect	enable()	Fades in, or keeps the effect on if it's already.
ScreenEffect	enableFor(int ticks)	Fades in, stays for ticks, then fades out: a flash, a pulse, a hit.
ScreenEffect	enableInstantly()	Shows the effect at full fade right away, skipping the fade-in.
@Nullable String	error()	Why it failed to load or draw, if it did.
ScreenEffect	fade(int fadeInTicks, int fadeOutTicks, Easing easing)	How it fades in and out.
net.minecraft.resources.ResourceLocation	id()
boolean	isAutomatic()	Whether it has an ScreenEffect.activeWhen(java.util.function.Predicate<net.ixdarklord.coolcatcanvas.api.client.effect.EffectContext>) condition deciding when it's on.
boolean	isEnabled()	Whether it's enabled; it may still be fading in.
boolean	isLoaded()	Whether its shaders compiled and it can be drawn.
boolean	isSelectable()	Whether players can turn it on and off from the effects screen, where their choice is remembered.
boolean	isVisible()	Whether it's drawn this frame: enabled or still fading out, with a strength above 0.
float	manualStrength()	The manual strength, or where its animation is heading.
ScreenEffect	onFrame(@Nullable Consumer<EffectContext> callback)	Runs every frame before drawing, while the effect is visible: a place to drive uniforms.
int	priority()
ScreenEffect	priority(int priority)	Where the effect starts in the layer order: lower priorities are drawn first, so later effects process their output.
ScreenEffect	resetUniforms()	Resets every uniform to its definition's default.
ScreenEffectScope	scope()
ScreenEffect	scope(ScreenEffectScope scope)	Where in the frame it's drawn.
ScreenEffect	selectable(boolean selectable)
ScreenEffect	setStrength(float strength)	Sets the manual strength, clamped to [0, 1].
float	strength()	The strength the effect is drawn with this frame.
ScreenEffect	strength(@Nullable EffectContext.StrengthFunction function)	Scales the strength by a function of the frame, clamped to [0, 1]; null to stop.
EffectUniform	uniform(String name)	The uniform named name in any of its passes' programs.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.ixdarklord.coolcatcanvas.api.client.effect.ScreenEffect

bindUniform, bindUniform, fade, setEnabled, setUniform, setUniformInt, toggle

Method Details

id

public net.minecraft.resources.ResourceLocation id()

Specified by:

id in interface ScreenEffect

definitionId

@Nullable
public @Nullable net.minecraft.resources.ResourceLocation definitionId()

Description copied from interface: ScreenEffect

The post chain JSON it's loaded from (shaders/post/<path>.json), or null for a definition built in code.

Specified by:

definitionId in interface ScreenEffect

displayName

public net.minecraft.network.chat.Component displayName()

Description copied from interface: ScreenEffect

The name shown in the effects screen: by default screen_effect.<namespace>.<path>, else the path.

Specified by:

displayName in interface ScreenEffect

displayName

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

Specified by:

displayName in interface ScreenEffect

description

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

Description copied from interface: ScreenEffect

A line or two shown in the effects screen, or null.

Specified by:

description in interface ScreenEffect

description

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

Specified by:

description in interface ScreenEffect

isSelectable

public boolean isSelectable()

Description copied from interface: ScreenEffect

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 ScreenEffect.activeWhen(java.util.function.Predicate<net.ixdarklord.coolcatcanvas.api.client.effect.EffectContext>) condition is listed but can't be toggled there).

Specified by:

isSelectable in interface ScreenEffect

selectable

public ScreenEffect selectable(boolean selectable)

Specified by:

selectable in interface ScreenEffect

isAutomatic

public boolean isAutomatic()

Description copied from interface: ScreenEffect

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

Specified by:

isAutomatic in interface ScreenEffect

scope

public ScreenEffectScope scope()

Specified by:

scope in interface ScreenEffect

scope

public ScreenEffect scope(ScreenEffectScope scope)

Description copied from interface: ScreenEffect

Where in the frame it's drawn. Defaults to ScreenEffectScope.WORLD.

Specified by:

scope in interface ScreenEffect

priority

public int priority()

Specified by:

priority in interface ScreenEffect

priority

public ScreenEffect priority(int priority)

Description copied from interface: ScreenEffect

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().

Specified by:

priority in interface ScreenEffect

fade

public ScreenEffect fade(int fadeInTicks,
 int fadeOutTicks,
 Easing easing)

Description copied from interface: ScreenEffect

How it fades in and out. Both default to 10 ticks with Easing.SINE_IN_OUT.

Specified by:

fade in interface ScreenEffect

autoBlend

public ScreenEffect autoBlend(boolean autoBlend)

Description copied from interface: ScreenEffect

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.

Specified by:

autoBlend in interface ScreenEffect

activeWhen

public ScreenEffect activeWhen(@Nullable
 @Nullable Predicate<EffectContext> condition)

Description copied from interface: ScreenEffect

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.

Specified by:

activeWhen in interface ScreenEffect

strength

public ScreenEffect strength(@Nullable EffectContext.StrengthFunction function)

Description copied from interface: ScreenEffect

Scales the strength by a function of the frame, clamped to [0, 1]; null to stop.

Specified by:

strength in interface ScreenEffect

onFrame

public ScreenEffect onFrame(@Nullable
 @Nullable Consumer<EffectContext> callback)

Description copied from interface: ScreenEffect

Runs every frame before drawing, while the effect is visible: a place to drive uniforms.

Specified by:

onFrame in interface ScreenEffect

enable

public ScreenEffect enable()

Description copied from interface: ScreenEffect

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

Specified by:

enable in interface ScreenEffect

disable

public ScreenEffect disable()

Description copied from interface: ScreenEffect

Fades out.

Specified by:

disable in interface ScreenEffect

enableFor

public ScreenEffect enableFor(int ticks)

Description copied from interface: ScreenEffect

Fades in, stays for ticks, then fades out: a flash, a pulse, a hit.

Specified by:

enableFor in interface ScreenEffect

enableInstantly

public ScreenEffect enableInstantly()

Description copied from interface: ScreenEffect

Shows the effect at full fade right away, skipping the fade-in.

Specified by:

enableInstantly in interface ScreenEffect

disableInstantly

public ScreenEffect disableInstantly()

Description copied from interface: ScreenEffect

Hides the effect right away, skipping the fade-out.

Specified by:

disableInstantly in interface ScreenEffect

isEnabled

public boolean isEnabled()

Description copied from interface: ScreenEffect

Whether it's enabled; it may still be fading in.

Specified by:

isEnabled in interface ScreenEffect

isVisible

public boolean isVisible()

Description copied from interface: ScreenEffect

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

Specified by:

isVisible in interface ScreenEffect

setStrength

public ScreenEffect setStrength(float strength)

Description copied from interface: ScreenEffect

Sets the manual strength, clamped to [0, 1].

Specified by:

setStrength in interface ScreenEffect

animateStrength

public ScreenEffect animateStrength(float target,
 int ticks,
 Easing easing)

Description copied from interface: ScreenEffect

Moves the manual strength to target over ticks.

Specified by:

animateStrength in interface ScreenEffect

manualStrength

public float manualStrength()

The manual strength, or where its animation is heading.

strength

public float strength()

Description copied from interface: ScreenEffect

The strength the effect is drawn with this frame.

Specified by:

strength in interface ScreenEffect

uniform

public EffectUniform uniform(String name)

Description copied from interface: ScreenEffect

The uniform named name in any of its passes' programs.

Specified by:

uniform in interface ScreenEffect

resetUniforms

public ScreenEffect resetUniforms()

Description copied from interface: ScreenEffect

Resets every uniform to its definition's default.

Specified by:

resetUniforms in interface ScreenEffect

isLoaded

public boolean isLoaded()

Description copied from interface: ScreenEffect

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

Specified by:

isLoaded in interface ScreenEffect

error

@Nullable
public @Nullable String error()

Description copied from interface: ScreenEffect

Why it failed to load or draw, if it did. Fixed by a resource reload.

Specified by:

error in interface ScreenEffect