Package org.lwjgl.util.zstd

Class ZSTDFrameProgression

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

Layout


 struct ZSTD_frameProgression {
     unsigned long long ingested();
     unsigned long long consumed();
     unsigned long long produced();
     unsigned long long flushed();
     unsigned int currentJobID();
     unsigned int nbActiveWorkers();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • INGESTED

      public static final int INGESTED
      The struct member offsets.

    • CONSUMED

      public static final int CONSUMED
      The struct member offsets.

    • PRODUCED

      public static final int PRODUCED
      The struct member offsets.

    • FLUSHED

      public static final int FLUSHED
      The struct member offsets.

    • CURRENTJOBID

      public static final int CURRENTJOBID
      The struct member offsets.

    • NBACTIVEWORKERS

      public static final int NBACTIVEWORKERS
      The struct member offsets.

  • Constructor Details

    • ZSTDFrameProgression

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

    • ingested

      public long ingested()
      nb input bytes read and buffered

    • consumed

      public long consumed()
      nb input bytes actually compressed

    • produced

      public long produced()
      nb of compressed bytes generated and buffered

    • flushed

      public long flushed()
      nb of compressed bytes flushed: not provided; can be tracked from caller side

    • currentJobID

      public int currentJobID()
      mT only: latest started job nb

    • nbActiveWorkers

      public int nbActiveWorkers()
      mT only: nb of workers actively compressing at probe time

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • mallocStack

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

    • callocStack

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

    • mallocStack

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

    • callocStack

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

    • mallocStack

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

    • callocStack

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

    • mallocStack

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

    • calloc

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

    • malloc

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

    • calloc

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

    • ningested

      public static long ningested(long struct)
      Unsafe version of ingested().

    • nconsumed

      public static long nconsumed(long struct)
      Unsafe version of consumed().

    • nproduced

      public static long nproduced(long struct)
      Unsafe version of produced().

    • nflushed

      public static long nflushed(long struct)
      Unsafe version of flushed().

    • ncurrentJobID

      public static int ncurrentJobID(long struct)
      Unsafe version of currentJobID().

    • nnbActiveWorkers

      public static int nnbActiveWorkers(long struct)
      Unsafe version of nbActiveWorkers().