Package org.lwjgl.stb

Class STBRPRect

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

    public class STBRPRect
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    A packed rectangle.

    Member documentation

    • id – reserved for your use
    • w – input width
    • h – input height
    • x – output x coordinate
    • y – output y coordinate
    • was_packed – non-zero if valid packing

    Layout

    
     struct stbrp_rect {
         int id;
         stbrp_coord w;
         stbrp_coord h;
         stbrp_coord x;
         stbrp_coord y;
         int was_packed;
     }
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  STBRPRect.Buffer
      An array of STBRPRect 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 H
      ID
      The struct member offsets.
      static int SIZEOF
      The struct size in bytes.
      static int W
      WAS_PACKED
      X
      Y
      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
      STBRPRect​(java.nio.ByteBuffer container)
      Creates a STBRPRect instance at the current position of the specified ByteBuffer container.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static STBRPRect calloc()
      Returns a new STBRPRect instance allocated with memCalloc.
      static STBRPRect.Buffer calloc​(int capacity)
      Returns a new STBRPRect.Buffer instance allocated with memCalloc.
      static STBRPRect callocStack()
      Returns a new STBRPRect instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      static STBRPRect.Buffer callocStack​(int capacity)
      Returns a new STBRPRect.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      static STBRPRect.Buffer callocStack​(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new STBRPRect.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      static STBRPRect callocStack​(org.lwjgl.system.MemoryStack stack)
      Returns a new STBRPRect instance allocated on the specified MemoryStack and initializes all its bits to zero.
      static STBRPRect create()
      Returns a new STBRPRect instance allocated with BufferUtils.
      static STBRPRect.Buffer create​(int capacity)
      Returns a new STBRPRect.Buffer instance allocated with BufferUtils.
      static STBRPRect create​(long address)
      Returns a new STBRPRect instance for the specified memory address.
      static STBRPRect.Buffer create​(long address, int capacity)
      Create a STBRPRect.Buffer instance at the specified memory.
      static STBRPRect createSafe​(long address)
      Like create, but returns null if address is NULL.
      static STBRPRect.Buffer createSafe​(long address, int capacity)
      Like create, but returns null if address is NULL.
      short h()
      Returns the value of the h field.
      STBRPRect h​(short value)
      Sets the specified value to the h field.
      int id()
      Returns the value of the id field.
      STBRPRect id​(int value)
      Sets the specified value to the id field.
      static STBRPRect malloc()
      Returns a new STBRPRect instance allocated with memAlloc.
      static STBRPRect.Buffer malloc​(int capacity)
      Returns a new STBRPRect.Buffer instance allocated with memAlloc.
      static STBRPRect mallocStack()
      Returns a new STBRPRect instance allocated on the thread-local MemoryStack.
      static STBRPRect.Buffer mallocStack​(int capacity)
      Returns a new STBRPRect.Buffer instance allocated on the thread-local MemoryStack.
      static STBRPRect.Buffer mallocStack​(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new STBRPRect.Buffer instance allocated on the specified MemoryStack.
      static STBRPRect mallocStack​(org.lwjgl.system.MemoryStack stack)
      Returns a new STBRPRect instance allocated on the specified MemoryStack.
      static short nh​(long struct)
      Unsafe version of h().
      static void nh​(long struct, short value)
      Unsafe version of h.
      static int nid​(long struct)
      Unsafe version of id().
      static void nid​(long struct, int value)
      Unsafe version of id.
      static short nw​(long struct)
      Unsafe version of w().
      static void nw​(long struct, short value)
      Unsafe version of w.
      static int nwas_packed​(long struct)
      Unsafe version of was_packed().
      static void nwas_packed​(long struct, int value)
      Unsafe version of was_packed.
      static short nx​(long struct)
      Unsafe version of x().
      static void nx​(long struct, short value)
      Unsafe version of x.
      static short ny​(long struct)
      Unsafe version of y().
      static void ny​(long struct, short value)
      Unsafe version of y.
      STBRPRect set​(int id, short w, short h, short x, short y, boolean was_packed)
      Initializes this struct with the specified values.
      STBRPRect set​(STBRPRect src)
      Copies the specified struct data to this struct.
      int sizeof()  
      short w()
      Returns the value of the w field.
      STBRPRect w​(short value)
      Sets the specified value to the w field.
      boolean was_packed()
      Returns the value of the was_packed field.
      STBRPRect was_packed​(boolean value)
      Sets the specified value to the was_packed field.
      short x()
      Returns the value of the x field.
      STBRPRect x​(short value)
      Sets the specified value to the x field.
      short y()
      Returns the value of the y field.
      STBRPRect y​(short value)
      Sets the specified value to the y 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
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • ID, W, H, X, Y, WAS_PACKED

        The struct member offsets.
    • Constructor Detail

      • STBRPRect

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

        public int id()
        Returns the value of the id field.
      • w

        public short w()
        Returns the value of the w field.
      • h

        public short h()
        Returns the value of the h field.
      • x

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

        public short y()
        Returns the value of the y field.
      • was_packed

        public boolean was_packed()
        Returns the value of the was_packed field.
      • id

        public STBRPRect id​(int value)
        Sets the specified value to the id field.
      • w

        public STBRPRect w​(short value)
        Sets the specified value to the w field.
      • h

        public STBRPRect h​(short value)
        Sets the specified value to the h field.
      • x

        public STBRPRect x​(short value)
        Sets the specified value to the x field.
      • y

        public STBRPRect y​(short value)
        Sets the specified value to the y field.
      • was_packed

        public STBRPRect was_packed​(boolean value)
        Sets the specified value to the was_packed field.
      • set

        public STBRPRect set​(int id,
                             short w,
                             short h,
                             short x,
                             short y,
                             boolean was_packed)
        Initializes this struct with the specified values.
      • set

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        public static STBRPRect.Buffer callocStack​(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
        Returns a new STBRPRect.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
      • nid

        public static int nid​(long struct)
        Unsafe version of id().
      • nw

        public static short nw​(long struct)
        Unsafe version of w().
      • nh

        public static short nh​(long struct)
        Unsafe version of h().
      • nx

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

        public static short ny​(long struct)
        Unsafe version of y().
      • nwas_packed

        public static int nwas_packed​(long struct)
        Unsafe version of was_packed().
      • nid

        public static void nid​(long struct,
                               int value)
        Unsafe version of id.
      • nw

        public static void nw​(long struct,
                              short value)
        Unsafe version of w.
      • nh

        public static void nh​(long struct,
                              short value)
        Unsafe version of h.
      • nx

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

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

        public static void nwas_packed​(long struct,
                                       int value)
        Unsafe version of was_packed.