Package dev.prozilla.pine.core

Enum Class WindowHint

java.lang.Object
java.lang.Enum<WindowHint>
dev.prozilla.pine.core.WindowHint
All Implemented Interfaces:
IntEnum, Serializable, Comparable<WindowHint>, Constable
public enum WindowHint extends Enum<WindowHint> implements IntEnum
Window hints can be set before the creation of a window and context and can affect the window itself, the framebuffer or the context.

Some hints are platform specific. These are always valid to set on any platform, but they will only affect their specific platform. Other platforms will ignore them.

See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AUTO_ICONIFY
    Specifies whether the fullscreen window will automatically iconify and restore the previous video mode on input focus loss.
    CENTER_CURSOR
    Specifies whether the cursor should be centered over newly created fullscreen windows.
    DECORATED
    Specifies whether the windowed mode window will have window decorations such as border, a close widget, etc.
    ENABLE_TRANSPARENT_FRAMEBUFFER
    Specifies whether the window framebuffer will be transparent.
    FLOATING
    Specifies whether the windowed mode window will be floating above other regular windows, also called always-on-top.
    FOCUS_ON_SHOW
    Specifies whether the window will be given input focus when shown.
    FOCUSED
    Specifies whether the windowed mode window will be given input focus when created.
    GL_FORWARD_COMPATIBLE
    Specifies whether the OpenGL context should be forward-compatible.
    GL_PROFILE
    Specifies which OpenGL profile to create the context for.
    GL_VERSION_MAJOR
    Specifies the major version of the OpenGL context.
    GL_VERSION_MINOR
    Specifies the minor version of the OpenGL context.
    MAXIMIZED
    Specifies whether the windowed mode window will be maximized when created.
    RESIZABLE
    Specifies whether the windowed mode window will be resizable by the user.
    RETINA_FRAMEBUFFER
    Specifies whether to use full resolution framebuffers on retina displays.
    SCALE_TO_MONITOR
    Specifies whether the window should be resized based on the monitor content scale.
    VISIBLE
    Specifies whether the windowed mode window will be initially visible.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getValue()
    Returns the integer value of this instance.
    static boolean
    isValid(int value)
    Checks if a given value is a valid value for a GLFW window hint.
    static WindowHint
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static WindowHint[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface dev.prozilla.pine.common.IntEnum

    toProperty

  • Enum Constant Details

    • DECORATED

      public static final WindowHint DECORATED
      Specifies whether the windowed mode window will have window decorations such as border, a close widget, etc.

    • VISIBLE

      public static final WindowHint VISIBLE
      Specifies whether the windowed mode window will be initially visible.

    • ENABLE_TRANSPARENT_FRAMEBUFFER

      public static final WindowHint ENABLE_TRANSPARENT_FRAMEBUFFER
      Specifies whether the window framebuffer will be transparent.

    • RESIZABLE

      public static final WindowHint RESIZABLE
      Specifies whether the windowed mode window will be resizable by the user.

    • FOCUSED

      public static final WindowHint FOCUSED
      Specifies whether the windowed mode window will be given input focus when created.

    • AUTO_ICONIFY

      public static final WindowHint AUTO_ICONIFY
      Specifies whether the fullscreen window will automatically iconify and restore the previous video mode on input focus loss.

    • FLOATING

      public static final WindowHint FLOATING
      Specifies whether the windowed mode window will be floating above other regular windows, also called always-on-top.

    • MAXIMIZED

      public static final WindowHint MAXIMIZED
      Specifies whether the windowed mode window will be maximized when created.

    • CENTER_CURSOR

      public static final WindowHint CENTER_CURSOR
      Specifies whether the cursor should be centered over newly created fullscreen windows.

    • FOCUS_ON_SHOW

      public static final WindowHint FOCUS_ON_SHOW
      Specifies whether the window will be given input focus when shown.

    • SCALE_TO_MONITOR

      public static final WindowHint SCALE_TO_MONITOR
      Specifies whether the window should be resized based on the monitor content scale.

    • GL_VERSION_MAJOR

      public static final WindowHint GL_VERSION_MAJOR
      Specifies the major version of the OpenGL context.

    • GL_VERSION_MINOR

      public static final WindowHint GL_VERSION_MINOR
      Specifies the minor version of the OpenGL context.

    • GL_FORWARD_COMPATIBLE

      public static final WindowHint GL_FORWARD_COMPATIBLE
      Specifies whether the OpenGL context should be forward-compatible.

    • GL_PROFILE

      public static final WindowHint GL_PROFILE
      Specifies which OpenGL profile to create the context for.

    • RETINA_FRAMEBUFFER

      public static final WindowHint RETINA_FRAMEBUFFER
      Specifies whether to use full resolution framebuffers on retina displays.

  • Method Details

    • values

      public static WindowHint[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static WindowHint valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public int getValue()
      Description copied from interface: IntEnum
      Returns the integer value of this instance.
      Specified by:
      getValue in interface IntEnum
      Returns:
      The integer value.

    • isValid

      public static boolean isValid(int value)
      Checks if a given value is a valid value for a GLFW window hint.
      Parameters:
      value - Value to test
      Returns:
      True if the value is a valid value