Class POINT

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

    public class POINT
    extends Struct
    implements NativeResource
    Defines the x- and y- coordinates of a point.

    Member documentation

    • x – the x-coordinate of the point
    • y – the y-coordinate of the point

    Layout

    
     struct POINT {
         LONG x;
         LONG y;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • X, Y

        The struct member offsets.
    • Constructor Detail

      • POINT

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

        public int x()
        Returns the value of the x field.
      • y

        public int y()
        Returns the value of the y field.
      • x

        public POINT x​(int value)
        Sets the specified value to the x field.
      • y

        public POINT y​(int value)
        Sets the specified value to the y field.
      • set

        public POINT set​(int x,
                         int y)
        Initializes this struct with the specified values.
      • set

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

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

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

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

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

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

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

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

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

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

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

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

        public static POINT callocStack​(MemoryStack stack)
        Returns a new POINT instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • mallocStack

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

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

        public static POINT.Buffer mallocStack​(int capacity,
                                               MemoryStack stack)
        Returns a new POINT.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • callocStack

        public static POINT.Buffer callocStack​(int capacity,
                                               MemoryStack stack)
        Returns a new POINT.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
      • nx

        public static int nx​(long struct)
        Unsafe version of x().
      • ny

        public static int ny​(long struct)
        Unsafe version of y().
      • nx

        public static void nx​(long struct,
                              int value)
        Unsafe version of x.
      • ny

        public static void ny​(long struct,
                              int value)
        Unsafe version of y.