Class RECT

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

    public class RECT
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Defines the coordinates of the upper-left and lower-right corners of a rectangle.

    Layout

    
     struct RECT {
         LONG left();
         LONG top();
         LONG right();
         LONG bottom();
     }
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RECT.Buffer
      An array of RECT structs.
      • Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

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

        org.lwjgl.system.Struct.StructValidation
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALIGNOF
      The struct alignment in bytes.
      static int BOTTOM
      LEFT
      RIGHT
      The struct member offsets.
      static int SIZEOF
      The struct size in bytes.
      static int TOP
      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
      RECT​(java.nio.ByteBuffer container)
      Creates a RECT instance at the current position of the specified ByteBuffer container.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      int bottom()
      the y-coordinate of the lower-right corner of the rectangle
      RECT bottom​(int value)
      Sets the specified value to the bottom() field.
      static RECT calloc()
      Returns a new RECT instance allocated with memCalloc.
      static RECT.Buffer calloc​(int capacity)
      Returns a new RECT.Buffer instance allocated with memCalloc.
      static RECT.Buffer calloc​(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new RECT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      static RECT calloc​(org.lwjgl.system.MemoryStack stack)
      Returns a new RECT instance allocated on the specified MemoryStack and initializes all its bits to zero.
      static RECT callocStack()
      Deprecated.
      static RECT.Buffer callocStack​(int capacity)
      Deprecated.
      static RECT.Buffer callocStack​(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      static RECT callocStack​(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      static RECT create()
      Returns a new RECT instance allocated with BufferUtils.
      static RECT.Buffer create​(int capacity)
      Returns a new RECT.Buffer instance allocated with BufferUtils.
      static RECT create​(long address)
      Returns a new RECT instance for the specified memory address.
      static RECT.Buffer create​(long address, int capacity)
      Create a RECT.Buffer instance at the specified memory.
      static RECT createSafe​(long address)
      Like create, but returns null if address is NULL.
      static RECT.Buffer createSafe​(long address, int capacity)
      Like create, but returns null if address is NULL.
      int left()
      the x-coordinate of the upper-left corner of the rectangle
      RECT left​(int value)
      Sets the specified value to the left() field.
      static RECT malloc()
      Returns a new RECT instance allocated with memAlloc.
      static RECT.Buffer malloc​(int capacity)
      Returns a new RECT.Buffer instance allocated with memAlloc.
      static RECT.Buffer malloc​(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new RECT.Buffer instance allocated on the specified MemoryStack.
      static RECT malloc​(org.lwjgl.system.MemoryStack stack)
      Returns a new RECT instance allocated on the specified MemoryStack.
      static RECT mallocStack()
      Deprecated.
      static RECT.Buffer mallocStack​(int capacity)
      Deprecated.
      static RECT.Buffer mallocStack​(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      static RECT mallocStack​(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      static int nbottom​(long struct)
      Unsafe version of bottom().
      static void nbottom​(long struct, int value)
      Unsafe version of bottom.
      static int nleft​(long struct)
      Unsafe version of left().
      static void nleft​(long struct, int value)
      Unsafe version of left.
      static int nright​(long struct)
      Unsafe version of right().
      static void nright​(long struct, int value)
      Unsafe version of right.
      static int ntop​(long struct)
      Unsafe version of top().
      static void ntop​(long struct, int value)
      Unsafe version of top.
      int right()
      the x-coordinate of the lower-right corner of the rectangle
      RECT right​(int value)
      Sets the specified value to the right() field.
      RECT set​(int left, int top, int right, int bottom)
      Initializes this struct with the specified values.
      RECT set​(RECT src)
      Copies the specified struct data to this struct.
      int sizeof()  
      int top()
      the y-coordinate of the upper-left corner of the rectangle
      RECT top​(int value)
      Sets the specified value to the top() field.
      • Methods inherited from interface org.lwjgl.system.NativeResource

        close, free
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from class org.lwjgl.system.Pointer.Default

        address, equals, hashCode, toString
      • Methods inherited from class org.lwjgl.system.Struct

        clear, free, isNull, validate
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • LEFT, TOP, RIGHT, BOTTOM

        The struct member offsets.
    • Constructor Detail

      • RECT

        public RECT​(java.nio.ByteBuffer container)
        Creates a RECT 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
      • left

        public int left()
        the x-coordinate of the upper-left corner of the rectangle
      • top

        public int top()
        the y-coordinate of the upper-left corner of the rectangle
      • right

        public int right()
        the x-coordinate of the lower-right corner of the rectangle
      • bottom

        public int bottom()
        the y-coordinate of the lower-right corner of the rectangle
      • left

        public RECT left​(int value)
        Sets the specified value to the left() field.
      • top

        public RECT top​(int value)
        Sets the specified value to the top() field.
      • right

        public RECT right​(int value)
        Sets the specified value to the right() field.
      • bottom

        public RECT bottom​(int value)
        Sets the specified value to the bottom() field.
      • set

        public RECT set​(int left,
                        int top,
                        int right,
                        int bottom)
        Initializes this struct with the specified values.
      • set

        public RECT set​(RECT src)
        Copies the specified struct data to this struct.
        Parameters:
        src - the source struct
        Returns:
        this struct
      • malloc

        public static RECT malloc()
        Returns a new RECT instance allocated with memAlloc. The instance must be explicitly freed.
      • calloc

        public static RECT calloc()
        Returns a new RECT instance allocated with memCalloc. The instance must be explicitly freed.
      • create

        public static RECT create()
        Returns a new RECT instance allocated with BufferUtils.
      • create

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

        @Nullable
        public static RECT createSafe​(long address)
        Like create, but returns null if address is NULL.
      • malloc

        public static RECT.Buffer malloc​(int capacity)
        Returns a new RECT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity
      • calloc

        public static RECT.Buffer calloc​(int capacity)
        Returns a new RECT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity
      • create

        public static RECT.Buffer create​(int capacity)
        Returns a new RECT.Buffer instance allocated with BufferUtils.
        Parameters:
        capacity - the buffer capacity
      • create

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

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

        @Deprecated
        public static RECT mallocStack()
        Deprecated.
        Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
      • callocStack

        @Deprecated
        public static RECT callocStack()
        Deprecated.
        Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
      • mallocStack

        @Deprecated
        public static RECT mallocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
      • callocStack

        @Deprecated
        public static RECT callocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
      • mallocStack

        @Deprecated
        public static RECT.Buffer mallocStack​(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
      • callocStack

        @Deprecated
        public static RECT.Buffer callocStack​(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
      • malloc

        public static RECT malloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new RECT instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • calloc

        public static RECT calloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new RECT instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • malloc

        public static RECT.Buffer malloc​(int capacity,
                                         org.lwjgl.system.MemoryStack stack)
        Returns a new RECT.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • calloc

        public static RECT.Buffer calloc​(int capacity,
                                         org.lwjgl.system.MemoryStack stack)
        Returns a new RECT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • nleft

        public static int nleft​(long struct)
        Unsafe version of left().
      • ntop

        public static int ntop​(long struct)
        Unsafe version of top().
      • nright

        public static int nright​(long struct)
        Unsafe version of right().
      • nbottom

        public static int nbottom​(long struct)
        Unsafe version of bottom().
      • nleft

        public static void nleft​(long struct,
                                 int value)
        Unsafe version of left.
      • ntop

        public static void ntop​(long struct,
                                int value)
        Unsafe version of top.
      • nright

        public static void nright​(long struct,
                                  int value)
        Unsafe version of right.
      • nbottom

        public static void nbottom​(long struct,
                                   int value)
        Unsafe version of bottom.