Package org.lwjgl.util.lz4

Class LZ4FDecompressOptions

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<LZ4FDecompressOptions>
org.lwjgl.util.lz4.LZ4FDecompressOptions
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class LZ4FDecompressOptions extends org.lwjgl.system.Struct<LZ4FDecompressOptions> implements org.lwjgl.system.NativeResource

Layout


 struct LZ4F_decompressOptions_t {
     unsigned stableDst();
     unsigned skipChecksums();
     unsigned reserved1();
     unsigned reserved0();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • STABLEDST

      public static final int STABLEDST
      The struct member offsets.

    • SKIPCHECKSUMS

      public static final int SKIPCHECKSUMS
      The struct member offsets.

    • RESERVED1

      public static final int RESERVED1
      The struct member offsets.

    • RESERVED0

      public static final int RESERVED0
      The struct member offsets.

  • Constructor Details

    • LZ4FDecompressOptions

      public LZ4FDecompressOptions(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 Details

    • sizeof

      public int sizeof()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<LZ4FDecompressOptions>

    • stableDst

      public int stableDst()
      pledges that last 64KB decompressed data is present right before dstBuffer pointer.

      This optimization skips internal storage operations. Once set, this pledge must remain valid up to the end of current frame.

    • skipChecksums

      public int skipChecksums()
      disable checksum calculation and verification, even when one is present in frame, to save CPU time.

      Setting this option to 1 once disables all checksums for the rest of the frame.

    • reserved1

      public int reserved1()
      must be set to zero for forward compatibility

    • reserved0

      public int reserved0()
      idem

    • stableDst

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

    • skipChecksums

      public LZ4FDecompressOptions skipChecksums(int value)
      Sets the specified value to the skipChecksums() field.

    • reserved1

      public LZ4FDecompressOptions reserved1(int value)
      Sets the specified value to the reserved1() field.

    • reserved0

      public LZ4FDecompressOptions reserved0(int value)
      Sets the specified value to the reserved0() field.

    • set

      public LZ4FDecompressOptions set(int stableDst, int skipChecksums, int reserved1, int reserved0)
      Initializes this struct with the specified values.

    • set

      public LZ4FDecompressOptions set(LZ4FDecompressOptions src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • 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

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • mallocStack

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

    • callocStack

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

    • mallocStack

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

    • callocStack

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

    • mallocStack

      @Deprecated public static LZ4FDecompressOptions.Buffer mallocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static LZ4FDecompressOptions.Buffer callocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • mallocStack

      @Deprecated public static LZ4FDecompressOptions.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 LZ4FDecompressOptions.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 LZ4FDecompressOptions malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new LZ4FDecompressOptions instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static LZ4FDecompressOptions calloc(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

    • malloc

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

    • calloc

      public static LZ4FDecompressOptions.Buffer calloc(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:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • nstableDst

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

    • nskipChecksums

      public static int nskipChecksums(long struct)
      Unsafe version of skipChecksums().

    • nreserved1

      public static int nreserved1(long struct)
      Unsafe version of reserved1().

    • nreserved0

      public static int nreserved0(long struct)
      Unsafe version of reserved0().

    • nstableDst

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

    • nskipChecksums

      public static void nskipChecksums(long struct, int value)
      Unsafe version of skipChecksums.

    • nreserved1

      public static void nreserved1(long struct, int value)
      Unsafe version of reserved1.

    • nreserved0

      public static void nreserved0(long struct, int value)
      Unsafe version of reserved0.