Record Class RGBColor

java.lang.Object
java.lang.Record
net.xun.lib.common.api.misc.color.RGBColor
All Implemented Interfaces:
IColorBase

public record RGBColor(float red, float green, float blue) extends Record implements IColorBase
Represents a color in the RGB (Red, Green, Blue) color space.
  • Constructor Summary

    Constructors
    Constructor
    Description
    RGBColor(float red, float green, float blue)
    Constructs an RGBColor with the specified red, green, and blue.
  • Method Summary

    Modifier and Type
    Method
    Description
     
     
    float
    Returns the value of the blue record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    float
    Returns the value of the green record component.
    final int
    Returns a hash code value for this object.
    float
    red()
    Returns the value of the red record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface net.xun.lib.common.api.misc.color.IColorBase

    asHSL, asHSV
  • Constructor Details

    • RGBColor

      public RGBColor(float red, float green, float blue)
      Constructs an RGBColor with the specified red, green, and blue.
      Parameters:
      red - the red component (0-255)
      green - the green component (0-255)
      blue - the blue component (0-255)
      Throws:
      InvalidColorFormatException - if any component is outside the range [0, 255]
  • Method Details

    • asHex

      public String asHex()
      Specified by:
      asHex in interface IColorBase
    • asRGB

      public RGBColor asRGB()
      Specified by:
      asRGB in interface IColorBase
    • 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 interface IColorBase
      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 interface IColorBase
      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 '=='.
      Specified by:
      equals in interface IColorBase
      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.
    • red

      public float red()
      Returns the value of the red record component.
      Returns:
      the value of the red record component
    • green

      public float green()
      Returns the value of the green record component.
      Returns:
      the value of the green record component
    • blue

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