Record Class WindowDescriptor

java.lang.Object
java.lang.Record
dev.engine.graphics.window.WindowDescriptor
public record WindowDescriptor(String title, int width, int height, boolean resizable, boolean decorated, boolean fullscreen, boolean highDpi) extends Record
Describes window creation parameters. 
var window = WindowDescriptor.builder("My Game")
    .size(1280, 720)
    .resizable(true)
    .fullscreen(false)
    .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    WindowDescriptor.Builder
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    WindowDescriptor(String title, int width, int height)
    Simple constructor for backward compatibility.
    WindowDescriptor(String title, int width, int height, boolean resizable, boolean decorated, boolean fullscreen, boolean highDpi)
    Creates an instance of a WindowDescriptor record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static WindowDescriptor.Builder
    builder(String title)
     
    boolean
    decorated()
    Returns the value of the decorated record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    fullscreen()
    Returns the value of the fullscreen record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    height()
    Returns the value of the height record component.
    boolean
    highDpi()
    Returns the value of the highDpi record component.
    boolean
    resizable()
    Returns the value of the resizable record component.
    String
    title()
    Returns the value of the title record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    width()
    Returns the value of the width record component.

    Methods inherited from class Object

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

  • Constructor Details

    • WindowDescriptor

      public WindowDescriptor(String title, int width, int height)
      Simple constructor for backward compatibility.

    • WindowDescriptor

      public WindowDescriptor(String title, int width, int height, boolean resizable, boolean decorated, boolean fullscreen, boolean highDpi)
      Creates an instance of a WindowDescriptor record class.
      Parameters:
      title - the value for the title record component
      width - the value for the width record component
      height - the value for the height record component
      resizable - the value for the resizable record component
      decorated - the value for the decorated record component
      fullscreen - the value for the fullscreen record component
      highDpi - the value for the highDpi record component

  • Method Details

    • builder

      public static WindowDescriptor.Builder builder(String title)

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • title

      public String title()
      Returns the value of the title record component.
      Returns:
      the value of the title 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

    • resizable

      public boolean resizable()
      Returns the value of the resizable record component.
      Returns:
      the value of the resizable record component

    • decorated

      public boolean decorated()
      Returns the value of the decorated record component.
      Returns:
      the value of the decorated record component

    • fullscreen

      public boolean fullscreen()
      Returns the value of the fullscreen record component.
      Returns:
      the value of the fullscreen record component

    • highDpi

      public boolean highDpi()
      Returns the value of the highDpi record component.
      Returns:
      the value of the highDpi record component