Record Class Viewport

java.lang.Object
java.lang.Record
dev.engine.graphics.Viewport
Record Components:
x - left edge in pixels
y - top edge in pixels
width - width in pixels
height - height in pixels
public record Viewport(int x, int y, int width, int height) extends Record
Defines a rectangular region of the render target to draw into.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    aspectRatio()
     
    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.
    int
    height()
    Returns the value of the height record component.
    static Viewport
    of(int width, int height)
    Full-size viewport starting at origin.
    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 Object

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

  • Constructor Details

    • Viewport

      public Viewport(int x, int y, int width, int height)
      Creates an instance of a Viewport record class.
      Parameters:
      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

    • of

      public static Viewport of(int width, int height)
      Full-size viewport starting at origin.

    • aspectRatio

      public float aspectRatio()

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

    • 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