Package org.lwjgl.util.lz4

Class LZ4FCompressOptions

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

Layout


 struct LZ4F_compressOptions_t {
     unsigned stableSrc();
     unsigned reserved[3];
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • STABLESRC

      public static final int STABLESRC
      The struct member offsets.

    • RESERVED

      public static final int RESERVED
      The struct member offsets.

  • Constructor Details

    • LZ4FCompressOptions

      public LZ4FCompressOptions(ByteBuffer container)
      Creates a LZ4FCompressOptions 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<LZ4FCompressOptions>

    • stableSrc

      public int stableSrc()
      1 == src content will remain present on future calls to LZ4F_compress(); skip copying src content within tmp buffer

    • reserved

      public 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.

    • stableSrc

      public LZ4FCompressOptions stableSrc(int value)
      Sets the specified value to the stableSrc() field.

    • reserved

      public LZ4FCompressOptions reserved(IntBuffer value)
      Copies the specified IntBuffer to the reserved field.

    • reserved

      public LZ4FCompressOptions reserved(int index, int value)
      Sets the specified value at the specified index of the reserved field.

    • set

      public LZ4FCompressOptions set(int stableSrc, IntBuffer reserved)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

      public static LZ4FCompressOptions create(long address)
      Returns a new LZ4FCompressOptions instance for the specified memory address.

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • mallocStack

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

    • callocStack

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

    • mallocStack

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

    • callocStack

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

    • mallocStack

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

    • callocStack

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

    • mallocStack

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

    • calloc

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

    • malloc

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

    • calloc

      public static LZ4FCompressOptions.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new LZ4FCompressOptions.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

    • nstableSrc

      public static int nstableSrc(long struct)
      Unsafe version of stableSrc().

    • nreserved

      public static IntBuffer nreserved(long struct)
      Unsafe version of reserved().

    • nreserved

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

    • nstableSrc

      public static void nstableSrc(long struct, int value)
      Unsafe version of stableSrc.

    • nreserved

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

    • nreserved

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