Record Class GuiAspectRatio

java.lang.Object
java.lang.Record
com.render.api.gui.layout.GuiAspectRatio
Record Components:
width - positive ratio width, or zero for automatic
height - positive ratio height, or zero for automatic
public record GuiAspectRatio(float width, float height) extends Record
Preferred box aspect ratio.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final GuiAspectRatio
    AUTO
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    GuiAspectRatio(float width, float height)
    Creates an instance of a GuiAspectRatio record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    automatic()
     
    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.
    float
    height()
    Returns the value of the height record component.
    static GuiAspectRatio
    of(float width, float height)
     
    final String
    toString()
    Returns a string representation of this record class.
    float
    value()
     
    float
    width()
    Returns the value of the width record component.

    Methods inherited from class Object

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

  • Field Details

  • Constructor Details

    • GuiAspectRatio

      public GuiAspectRatio(float width, float height)
      Creates an instance of a GuiAspectRatio record class.
      Parameters:
      width - the value for the width record component
      height - the value for the height record component

  • Method Details

    • of

      public static GuiAspectRatio of(float width, float height)

    • automatic

      public boolean automatic()

    • value

      public float 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 the compare method from their corresponding wrapper classes.
      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.

    • width

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

    • height

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