Class RECT

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

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

    Member documentation

    • left – the x-coordinate of the upper-left corner of the rectangle
    • top – the y-coordinate of the upper-left corner of the rectangle
    • right – the x-coordinate of the lower-right corner of the rectangle
    • bottom – the y-coordinate of the lower-right corner of the rectangle

    Layout

    
     struct RECT {
         LONG left;
         LONG top;
         LONG right;
         LONG bottom;
     }
    • 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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • left

        public int left()
        Returns the value of the left field.
      • top

        public int top()
        Returns the value of the top field.
      • right

        public int right()
        Returns the value of the right field.
      • bottom

        public int bottom()
        Returns the value of the bottom field.
      • 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​(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

        public static RECT mallocStack()
        Returns a new RECT instance allocated on the thread-local MemoryStack.
      • callocStack

        public static RECT callocStack()
        Returns a new RECT instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

        public static RECT mallocStack​(MemoryStack stack)
        Returns a new RECT instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static RECT callocStack​(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
      • mallocStack

        public static RECT.Buffer mallocStack​(int capacity)
        Returns a new RECT.Buffer instance allocated on the thread-local MemoryStack.
        Parameters:
        capacity - the buffer capacity
      • callocStack

        public static RECT.Buffer callocStack​(int capacity)
        Returns a new RECT.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
        Parameters:
        capacity - the buffer capacity
      • mallocStack

        public static RECT.Buffer mallocStack​(int capacity,
                                              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
      • callocStack

        public static RECT.Buffer callocStack​(int capacity,
                                              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.