Module technology.sola.engine
Package technology.sola.engine.assets.graphics.font

Record Class FontGlyph

java.lang.Object
java.lang.Record
technology.sola.engine.assets.graphics.font.FontGlyph
Record Components:
glyph - the rasterized glyph
x - the left coordinate of the glyph
y - the top coordinate of the glyph
width - the width of the glyph
height - the height of the glyph
@NullMarked public record FontGlyph(char glyph, int x, int y, int width, int height) extends Record
FontGlyph holds information on a glyph's placement in the rasterized Font

  • Constructor Summary

    Constructors
    Constructor
    Description
    FontGlyph(char glyph, int x, int y, int width, int height)
    Creates an instance of a FontGlyph record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    char
    glyph()
    Returns the value of the glyph record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    height()
    Returns the value of the height record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    width()
    Returns the value of the width record component.
    int
    x()
    Returns the value of the x record component.
    int
    y()
    Returns the value of the y record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • FontGlyph

      public FontGlyph(char glyph, int x, int y, int width, int height)
      Creates an instance of a FontGlyph record class.
      Parameters:
      glyph - the value for the glyph record component
      x - the value for the x record component
      y - the value for the y record component
      width - the value for the width record component
      height - the value for the height 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. All components in this record class 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.

    • glyph

      public char glyph()
      Returns the value of the glyph record component.
      Returns:
      the value of the glyph record component

    • x

      public int x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • y

      public int y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component

    • width

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

    • height

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