Package org.lwjgl.util.lz4

Class LZ4Stream

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<LZ4Stream>
org.lwjgl.util.lz4.LZ4Stream
All Implemented Interfaces:
org.lwjgl.system.Pointer
public class LZ4Stream extends org.lwjgl.system.Struct<LZ4Stream>

Layout


 union LZ4_stream_t {
     void * table[LZ4_STREAM_MINSIZE];
     struct LZ4_stream_t_internal internal_donotuse;
 }

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    LZ4Stream.Buffer
    An array of LZ4Stream structs.

    Nested classes/interfaces inherited from class org.lwjgl.system.Struct

    org.lwjgl.system.Struct.StructValidation

    Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

    org.lwjgl.system.Pointer.Default

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALIGNOF
    The struct alignment in bytes.
    static final int
    INTERNAL_DONOTUSE
    The struct member offsets.
    static final int
    SIZEOF
    The struct size in bytes.
    static final int
    TABLE
    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
    LZ4Stream(ByteBuffer container)
    Creates a LZ4Stream instance at the current position of the specified ByteBuffer container.

  • Method Summary

    Modifier and Type
    Method
    Description
    static LZ4Stream
    create(long address)
    Returns a new LZ4Stream instance for the specified memory address.
    static LZ4Stream.Buffer
    create(long address, int capacity)
    Create a LZ4Stream.Buffer instance at the specified memory.
    static @Nullable LZ4Stream
    createSafe(long address)
    Like create, but returns null if address is NULL.
    static @Nullable LZ4Stream.Buffer
    createSafe(long address, int capacity)
    Like create, but returns null if address is NULL.
    LZ4StreamInternal
    internal_donotuse()
     
    static LZ4StreamInternal
    ninternal_donotuse(long struct)
    Unsafe version of internal_donotuse().
    static org.lwjgl.PointerBuffer
    ntable(long struct)
    Unsafe version of table().
    static long
    ntable(long struct, int index)
    Unsafe version of table.
    int
    sizeof()
     
    org.lwjgl.PointerBuffer
    table()
     
    long
    table(int index)
     

    Methods inherited from class org.lwjgl.system.Struct

    clear, free, isNull, validate, validate

    Methods inherited from class org.lwjgl.system.Pointer.Default

    address, equals, hashCode, toString

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • TABLE

      public static final int TABLE
      The struct member offsets.

    • INTERNAL_DONOTUSE

      public static final int INTERNAL_DONOTUSE
      The struct member offsets.

  • Constructor Details

    • LZ4Stream

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

    • table

      public org.lwjgl.PointerBuffer table()
      Returns:
      a PointerBuffer view of the table field.

    • table

      public long table(int index)
      Returns:
      the value at the specified index of the table field.

    • internal_donotuse

      public LZ4StreamInternal internal_donotuse()
      Returns:
      a LZ4StreamInternal view of the internal_donotuse field.

    • create

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

    • createSafe

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

    • create

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

    • createSafe

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

    • ntable

      public static org.lwjgl.PointerBuffer ntable(long struct)
      Unsafe version of table().

    • ntable

      public static long ntable(long struct, int index)
      Unsafe version of table.

    • ninternal_donotuse

      public static LZ4StreamInternal ninternal_donotuse(long struct)
      Unsafe version of internal_donotuse().