Package ke.ric.renderer.api

Record Class MapOutputOptions

java.lang.Object
java.lang.Record
ke.ric.renderer.api.MapOutputOptions
Record Components:
dither - palette dithering strategy; no dithering by default
public record MapOutputOptions(MapDither dither) extends Record
Immutable Minecraft map-palette conversion options. These affect palette output, not the original RGBA image or native visibility evidence. Built-in single-map outputs preserve aspect ratio with black letterboxing; tile conversion remains available through MinecraftMapConverter.

  • Constructor Details

    • MapOutputOptions

      public MapOutputOptions(MapDither dither)
      Constructs a validated immutable value.
      Throws:
      NullPointerException - if dither is null

  • Method Details

    • defaults

      public static MapOutputOptions defaults()
      Selects map conversion without dithering.
      Returns:
      options using MapDither.NONE

    • dither

      public MapOutputOptions dither(MapDither value)
      Returns new conversion settings with the chosen palette-dither strategy.
      Parameters:
      value - NONE, BAYER or FLOYD_STEINBERG
      Returns:
      a new immutable options value

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • dither

      public MapDither dither()
      Returns the value of the dither record component.
      Returns:
      the value of the dither record component