Record Class GuiScrollInsets

java.lang.Object
java.lang.Record
com.render.api.gui.GuiScrollInsets
Record Components:
top - top inset
right - right inset
bottom - bottom inset
left - left inset
public record GuiScrollInsets(float top, float right, float bottom, float left) extends Record
Insets applied to the effective scroll-snap viewport.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final GuiScrollInsets
    ZERO
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    GuiScrollInsets(float top, float right, float bottom, float left)
    Creates an instance of a GuiScrollInsets record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    bottom()
    Returns the value of the bottom 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.
    float
    left()
    Returns the value of the left record component.
    float
    right()
    Returns the value of the right record component.
    static GuiScrollInsets
    symmetric(float vertical, float horizontal)
    Creates symmetric vertical and horizontal insets.
    float
    top()
    Returns the value of the top record component.
    final String
    toString()
    Returns a string representation of this record class.
    static GuiScrollInsets
    uniform(float value)
    Creates equal insets on all sides.

    Methods inherited from class Object

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

  • Field Details

  • Constructor Details

    • GuiScrollInsets

      public GuiScrollInsets(float top, float right, float bottom, float left)
      Creates an instance of a GuiScrollInsets record class.
      Parameters:
      top - the value for the top record component
      right - the value for the right record component
      bottom - the value for the bottom record component
      left - the value for the left record component

  • Method Details

    • uniform

      public static GuiScrollInsets uniform(float value)
      Creates equal insets on all sides.
      Parameters:
      value - inset in design-space pixels
      Returns:
      uniform insets

    • symmetric

      public static GuiScrollInsets symmetric(float vertical, float horizontal)
      Creates symmetric vertical and horizontal insets.
      Parameters:
      vertical - top and bottom inset
      horizontal - left and right inset
      Returns:
      symmetric insets

    • 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.

    • top

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

    • right

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

    • bottom

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

    • left

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