Package org.lwjgl.glfw

Class GLFWVidMode

  • All Implemented Interfaces:
    org.lwjgl.system.Pointer
    public class GLFWVidMode
extends org.lwjgl.system.Struct
    Describes a single video mode.

    Member documentation

    • width – the width, in screen coordinates, of the video mode
    • height – the height, in screen coordinates, of the video mode
    • redBits – the bit depth of the red channel of the video mode
    • greenBits – the bit depth of the green channel of the video mode
    • blueBits – the bit depth of the blue channel of the video mode
    • refreshRate – the refresh rate, in Hz, of the 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 interface org.lwjgl.system.Pointer

        org.lwjgl.system.Pointer.Default

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALIGNOF
      The struct alignment in bytes.
      static int BLUEBITS
      GREENBITS
      HEIGHT
      REDBITS
      REFRESHRATE
      The struct member offsets.
      static int SIZEOF
      The struct size in bytes.
      static 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​(java.nio.ByteBuffer container)
      Creates a GLFWVidMode instance at the current position of the specified ByteBuffer container.

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • WIDTH, HEIGHT, REDBITS, GREENBITS, BLUEBITS, REFRESHRATE

        The struct member offsets.

    • Constructor Detail

      • GLFWVidMode

        public GLFWVidMode​(java.nio.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 Detail

      • sizeof

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

      • width

        public int width()
        Returns the value of the width field.

      • height

        public int height()
        Returns the value of the height field.

      • redBits

        public int redBits()
        Returns the value of the redBits field.

      • greenBits

        public int greenBits()
        Returns the value of the greenBits field.

      • blueBits

        public int blueBits()
        Returns the value of the blueBits field.

      • refreshRate

        public int refreshRate()
        Returns the value of the refreshRate field.

      • create

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

      • createSafe

        @Nullable
public static 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

        @Nullable
public static 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().