Class LZ4FDecompressOptions

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

    public class LZ4FDecompressOptions
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource

    Member documentation

    • stableDst – pledges that last 64KB decompressed data will remain available unmodified. This optimization skips storage operations in tmp buffers.
    • reserved[3] – must be set to zero for forward compatibility

    Layout

    
     struct LZ4F_decompressOptions_t {
         unsigned stableDst;
         unsigned reserved[3];
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STABLEDST, RESERVED

        The struct member offsets.
    • Constructor Detail

      • LZ4FDecompressOptions

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

        public int stableDst()
        Returns the value of the stableDst field.
      • reserved

        public java.nio.IntBuffer reserved()
        Returns a IntBuffer view of the reserved field.
      • reserved

        public int reserved​(int index)
        Returns the value at the specified index of the reserved field.
      • stableDst

        public LZ4FDecompressOptions stableDst​(int value)
        Sets the specified value to the stableDst field.
      • reserved

        public LZ4FDecompressOptions reserved​(java.nio.IntBuffer value)
        Copies the specified IntBuffer to the reserved field.
      • reserved

        public LZ4FDecompressOptions reserved​(int index,
                                              int value)
        Sets the specified value at the specified index of the reserved field.
      • set

        public LZ4FDecompressOptions set​(int stableDst,
                                         java.nio.IntBuffer reserved)
        Initializes this struct with the specified values.
      • malloc

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

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

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

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

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

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

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

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

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

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

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

        public static int nstableDst​(long struct)
        Unsafe version of stableDst().
      • nreserved

        public static java.nio.IntBuffer nreserved​(long struct)
        Unsafe version of reserved().
      • nreserved

        public static int nreserved​(long struct,
                                    int index)
        Unsafe version of reserved.
      • nstableDst

        public static void nstableDst​(long struct,
                                      int value)
        Unsafe version of stableDst.
      • nreserved

        public static void nreserved​(long struct,
                                     java.nio.IntBuffer value)
        Unsafe version of reserved.
      • nreserved

        public static void nreserved​(long struct,
                                     int index,
                                     int value)
        Unsafe version of reserved.