Package org.lwjgl.util.zstd

Class ZSTDOutBuffer

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

 struct ZSTD_outBuffer {
     void * dst;
     size_t size;
     size_t pos;
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • DST

      public static final int DST
      The struct member offsets.

    • SIZE

      public static final int SIZE
      The struct member offsets.

    • POS

      public static final int POS
      The struct member offsets.

  • Constructor Details

    • ZSTDOutBuffer

      public ZSTDOutBuffer(ByteBuffer container)
      Creates a ZSTDOutBuffer 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()
      Description copied from class: Struct
      Returns sizeof(struct).
      Specified by:
      sizeof in class Struct<ZSTDOutBuffer>

    • dst

      public ByteBuffer dst()
      Returns:
      a ByteBuffer view of the data pointed to by the dst field.

    • size

      public long size()
      Returns:
      the value of the size field.

    • pos

      public long pos()
      Returns:
      the value of the pos field.

    • dst

      public ZSTDOutBuffer dst(ByteBuffer value)
      Sets the address of the specified ByteBuffer to the dst field.

    • pos

      public ZSTDOutBuffer pos(long value)
      Sets the specified value to the pos field.

    • set

      public ZSTDOutBuffer set(ByteBuffer dst, long pos)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

      public static ZSTDOutBuffer malloc(MemoryStack stack)
      Returns a new ZSTDOutBuffer instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

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

    • malloc

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

    • calloc

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

    • ndst

      public static ByteBuffer ndst(long struct)
      Unsafe version of dst.

    • nsize

      public static long nsize(long struct)
      Unsafe version of size().

    • npos

      public static long npos(long struct)
      Unsafe version of pos().

    • ndst

      public static void ndst(long struct, ByteBuffer value)
      Unsafe version of dst.

    • nsize

      public static void nsize(long struct, long value)
      Sets the specified value to the size field of the specified struct.

    • npos

      public static void npos(long struct, long value)
      Unsafe version of pos.

    • validate

      public static void validate(long struct)
      Validates pointer members that should not be NULL.
      Parameters:
      struct - the struct to validate