Package net.ixdarklord.coolcatcanvas.api.client.vfx

Enum Class VfxBlend

java.lang.Object
java.lang.Enum<VfxBlend>
net.ixdarklord.coolcatcanvas.api.client.vfx.VfxBlend
All Implemented Interfaces:
Serializable, Comparable<VfxBlend>, Constable
public enum VfxBlend extends Enum<VfxBlend>
How a world effect combines with the scene behind it. None of them writes depth, so effects never cut holes in each other.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ADDITIVE
    Added to the scene: light, fire, magic.
    ALPHA
    Painted over the scene by its alpha: smoke, dust, anything that should darken as well as lighten.
    LUMINOUS
    Painted over like ALPHA, taking the alpha from how bright each texel is: for glow textures drawn on black with no alpha channel, which additive blending would lose against a bright sky.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    luminanceAlpha()
    Whether the shader takes each texel's alpha from its brightness.
    static VfxBlend
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static VfxBlend[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ADDITIVE

      public static final VfxBlend ADDITIVE
      Added to the scene: light, fire, magic. Overlapping pieces brighten each other, and black adds nothing, so a greyscale glow on a black background needs no alpha channel. It washes out against a bright sky.

    • ALPHA

      public static final VfxBlend ALPHA
      Painted over the scene by its alpha: smoke, dust, anything that should darken as well as lighten.

    • LUMINOUS

      public static final VfxBlend LUMINOUS
      Painted over like ALPHA, taking the alpha from how bright each texel is: for glow textures drawn on black with no alpha channel, which additive blending would lose against a bright sky. (Canvas's own textures keep their brightness in alpha, so they need only ALPHA for that.)

  • Method Details

    • values

      public static VfxBlend[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static VfxBlend valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • luminanceAlpha

      public boolean luminanceAlpha()
      Whether the shader takes each texel's alpha from its brightness.