Package limn.graphics

Record Class LinearGradient

java.lang.Object
java.lang.Record
limn.graphics.LinearGradient
All Implemented Interfaces:
Paint
public record LinearGradient(float x0, float y0, float x1, float y1, Color start, Color end) extends Record implements Paint
Two-stop linear gradient from (x0,y0) (color start) to (x1,y1) (color end), clamped beyond the endpoints. Points are in the same logical coordinate space as the shape being painted.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LinearGradient(float x0, float y0, float x1, float y1, Color start, Color end)
    Creates an instance of a LinearGradient record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Color
    end()
    Returns the value of the end record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    Color
    start()
    Returns the value of the start record component.
    final String
    toString()
    Returns a string representation of this record class.
    float
    x0()
    Returns the value of the x0 record component.
    float
    x1()
    Returns the value of the x1 record component.
    float
    y0()
    Returns the value of the y0 record component.
    float
    y1()
    Returns the value of the y1 record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • LinearGradient

      public LinearGradient(float x0, float y0, float x1, float y1, Color start, Color end)
      Creates an instance of a LinearGradient record class.
      Parameters:
      x0 - the value for the x0 record component
      y0 - the value for the y0 record component
      x1 - the value for the x1 record component
      y1 - the value for the y1 record component
      start - the value for the start record component
      end - the value for the end record component

  • Method Details

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • x0

      public float x0()
      Returns the value of the x0 record component.
      Returns:
      the value of the x0 record component

    • y0

      public float y0()
      Returns the value of the y0 record component.
      Returns:
      the value of the y0 record component

    • x1

      public float x1()
      Returns the value of the x1 record component.
      Returns:
      the value of the x1 record component

    • y1

      public float y1()
      Returns the value of the y1 record component.
      Returns:
      the value of the y1 record component

    • start

      public Color start()
      Returns the value of the start record component.
      Returns:
      the value of the start record component

    • end

      public Color end()
      Returns the value of the end record component.
      Returns:
      the value of the end record component