Package net.risingworld.api.objects.visuals

Class FilmGrain

java.lang.Object
net.risingworld.api.objects.visuals.FilmGrain
public final class FilmGrain extends Object
Post-processing effect: Film grain (noise) effect. Used in conjunction with a PostProcessing object.

Image

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    FilmGrain.Type
    Determines the noise type (and size) of the film grain effect

  • Constructor Summary

    Constructors
    Constructor
    Description
    FilmGrain()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isOverridden()
    Determines if the effect is set.
    void
    reset()
    Resets the effect, so it is no longer active (and no longer overrides any game effects).
    void
    set(FilmGrain.Type type, float intensity, float response)
    Sets the film grain effect (screen-wide noise).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • FilmGrain

      public FilmGrain()

  • Method Details

    • set

      public void set(FilmGrain.Type type, float intensity, float response)
      Sets the film grain effect (screen-wide noise). To reset the value to the game default value, call reset()
      Parameters:
      type - noise type (grain type and size).
      intensity - noise intensity, between 0 and 1 (but higher values are also supported).
      response - noisiness response (0-1). The higher the value, the less noise is visible in brighter areas of the screen.

    • reset

      public void reset()
      Resets the effect, so it is no longer active (and no longer overrides any game effects).

    • isOverridden

      public boolean isOverridden()
      Determines if the effect is set.
      Returns:
      true if this effect was set, false if not (or if it was reset).