Package org.lwjgl.glfw

Class GLFWVidMode

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<GLFWVidMode>
org.lwjgl.glfw.GLFWVidMode
All Implemented Interfaces:
org.lwjgl.system.Pointer
public class GLFWVidMode extends org.lwjgl.system.Struct<GLFWVidMode>
Describes a single video mode.

Layout


 struct GLFWvidmode {
     int width();
     int height();
     int redBits();
     int greenBits();
     int blueBits();
     int refreshRate();
 }

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    GLFWVidMode.Buffer
    An array of GLFWVidMode structs.

    Nested classes/interfaces inherited from class org.lwjgl.system.Struct

    org.lwjgl.system.Struct.StructValidation

    Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

    org.lwjgl.system.Pointer.Default

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALIGNOF
    The struct alignment in bytes.
    static final int
    BLUEBITS
    The struct member offsets.
    static final int
    GREENBITS
    The struct member offsets.
    static final int
    HEIGHT
    The struct member offsets.
    static final int
    REDBITS
    The struct member offsets.
    static final int
    REFRESHRATE
    The struct member offsets.
    static final int
    SIZEOF
    The struct size in bytes.
    static final int
    WIDTH
    The struct member offsets.

    Fields inherited from interface org.lwjgl.system.Pointer

    BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

  • Constructor Summary

    Constructors
    Constructor
    Description
    GLFWVidMode(ByteBuffer container)
    Creates a GLFWVidMode instance at the current position of the specified ByteBuffer container.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    blueBits()
    the bit depth of the blue channel of the video mode
    static GLFWVidMode
    create(long address)
    Returns a new GLFWVidMode instance for the specified memory address.
    static GLFWVidMode.Buffer
    create(long address, int capacity)
    Create a GLFWVidMode.Buffer instance at the specified memory.
    static @Nullable GLFWVidMode
    createSafe(long address)
    Like create, but returns null if address is NULL.
    static @Nullable GLFWVidMode.Buffer
    createSafe(long address, int capacity)
    Like create, but returns null if address is NULL.
    int
    greenBits()
    the bit depth of the green channel of the video mode
    int
    height()
    the height, in screen coordinates, of the video mode
    static int
    nblueBits(long struct)
    Unsafe version of blueBits().
    static int
    ngreenBits(long struct)
    Unsafe version of greenBits().
    static int
    nheight(long struct)
    Unsafe version of height().
    static int
    nredBits(long struct)
    Unsafe version of redBits().
    static int
    nrefreshRate(long struct)
    Unsafe version of refreshRate().
    static int
    nwidth(long struct)
    Unsafe version of width().
    int
    redBits()
    the bit depth of the red channel of the video mode
    int
    refreshRate()
    the refresh rate, in Hz, of the video mode
    int
    sizeof()
     
    int
    width()
    the width, in screen coordinates, of the video mode

    Methods inherited from class org.lwjgl.system.Struct

    clear, free, isNull, validate, validate

    Methods inherited from class org.lwjgl.system.Pointer.Default

    address, equals, hashCode, toString

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • WIDTH

      public static final int WIDTH
      The struct member offsets.

    • HEIGHT

      public static final int HEIGHT
      The struct member offsets.

    • REDBITS

      public static final int REDBITS
      The struct member offsets.

    • GREENBITS

      public static final int GREENBITS
      The struct member offsets.

    • BLUEBITS

      public static final int BLUEBITS
      The struct member offsets.

    • REFRESHRATE

      public static final int REFRESHRATE
      The struct member offsets.

  • Constructor Details

    • GLFWVidMode

      public GLFWVidMode(ByteBuffer container)
      Creates a GLFWVidMode instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

      The created instance holds a strong reference to the container object.

  • Method Details

    • sizeof

      public int sizeof()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<GLFWVidMode>

    • width

      public int width()
      the width, in screen coordinates, of the video mode

    • height

      public int height()
      the height, in screen coordinates, of the video mode

    • redBits

      public int redBits()
      the bit depth of the red channel of the video mode

    • greenBits

      public int greenBits()
      the bit depth of the green channel of the video mode

    • blueBits

      public int blueBits()
      the bit depth of the blue channel of the video mode

    • refreshRate

      public int refreshRate()
      the refresh rate, in Hz, of the video mode

    • create

      public static GLFWVidMode create(long address)
      Returns a new GLFWVidMode instance for the specified memory address.

    • createSafe

      public static @Nullable GLFWVidMode createSafe(long address)
      Like create, but returns null if address is NULL.

    • create

      public static GLFWVidMode.Buffer create(long address, int capacity)
      Create a GLFWVidMode.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable GLFWVidMode.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • nwidth

      public static int nwidth(long struct)
      Unsafe version of width().

    • nheight

      public static int nheight(long struct)
      Unsafe version of height().

    • nredBits

      public static int nredBits(long struct)
      Unsafe version of redBits().

    • ngreenBits

      public static int ngreenBits(long struct)
      Unsafe version of greenBits().

    • nblueBits

      public static int nblueBits(long struct)
      Unsafe version of blueBits().

    • nrefreshRate

      public static int nrefreshRate(long struct)
      Unsafe version of refreshRate().