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 and 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 and Description
      static int SIZEOF
      The struct size in bytes.

      • Fields inherited from interface org.lwjgl.system.Pointer

        POINTER_SHIFT, POINTER_SIZE

    • Constructor Summary

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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int blueBits()
      Returns the value of the blueBits field.
      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 GLFWVidMode createSafe(long address)
      Like create, but returns null if address is NULL.
      static GLFWVidMode.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.
      int greenBits()
      Returns the value of the greenBits field.
      int height()
      Returns the value of the height field.
      int redBits()
      Returns the value of the redBits field.
      int refreshRate()
      Returns the value of the refreshRate field.
      int sizeof() 
      int width()
      Returns the value of the width field.

      • Methods inherited from class org.lwjgl.system.Struct

        clear, free, isNull

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

      • SIZEOF

        public static final int SIZEOF
        The struct size in bytes.

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