ZSTDFrameProgression (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.util.zstd.ZSTDFrameProgression

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class ZSTDFrameProgression
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Member documentation
- ingested – nb input bytes read and buffered
- consumed – nb input bytes actually compressed
- produced – nb of compressed bytes generated and buffered
- flushed – nb of compressed bytes flushed: not provided; can be tracked from caller side
- currentJobID – mT only: latest started job nb
- nbActiveWorkers – mT only: nb of workers actively compressing at probe time
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;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ZSTDFrameProgression.Buffer
An array of ZSTDFrameProgression structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`CONSUMED` The struct member offsets.
`static int`	`CURRENTJOBID` The struct member offsets.
`static int`	`FLUSHED` The struct member offsets.
`static int`	`INGESTED` The struct member offsets.
`static int`	`NBACTIVEWORKERS` The struct member offsets.
`static int`	`PRODUCED` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`ZSTDFrameProgression(java.nio.ByteBuffer container)` Creates a `ZSTDFrameProgression` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ZSTDFrameProgression`	`calloc()` Returns a new `ZSTDFrameProgression` instance allocated with `memCalloc`.
`static ZSTDFrameProgression.Buffer`	`calloc(int capacity)` Returns a new `ZSTDFrameProgression.Buffer` instance allocated with `memCalloc`.
`static ZSTDFrameProgression`	`callocStack()` Returns a new `ZSTDFrameProgression` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZSTDFrameProgression.Buffer`	`callocStack(int capacity)` Returns a new `ZSTDFrameProgression.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZSTDFrameProgression.Buffer`	`callocStack(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.
`static ZSTDFrameProgression`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDFrameProgression` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`long`	`consumed()` Returns the value of the `consumed` field.
`static ZSTDFrameProgression`	`create()` Returns a new `ZSTDFrameProgression` instance allocated with `BufferUtils`.
`static ZSTDFrameProgression.Buffer`	`create(int capacity)` Returns a new `ZSTDFrameProgression.Buffer` instance allocated with `BufferUtils`.
`static ZSTDFrameProgression`	`create(long address)` Returns a new `ZSTDFrameProgression` instance for the specified memory address.
`static ZSTDFrameProgression.Buffer`	`create(long address, int capacity)` Create a `ZSTDFrameProgression.Buffer` instance at the specified memory.
`static ZSTDFrameProgression`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static ZSTDFrameProgression.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`currentJobID()` Returns the value of the `currentJobID` field.
`long`	`flushed()` Returns the value of the `flushed` field.
`long`	`ingested()` Returns the value of the `ingested` field.
`static ZSTDFrameProgression`	`malloc()` Returns a new `ZSTDFrameProgression` instance allocated with `memAlloc`.
`static ZSTDFrameProgression.Buffer`	`malloc(int capacity)` Returns a new `ZSTDFrameProgression.Buffer` instance allocated with `memAlloc`.
`static ZSTDFrameProgression`	`mallocStack()` Returns a new `ZSTDFrameProgression` instance allocated on the thread-local `MemoryStack`.
`static ZSTDFrameProgression.Buffer`	`mallocStack(int capacity)` Returns a new `ZSTDFrameProgression.Buffer` instance allocated on the thread-local `MemoryStack`.
`static ZSTDFrameProgression.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDFrameProgression.Buffer` instance allocated on the specified `MemoryStack`.
`static ZSTDFrameProgression`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDFrameProgression` instance allocated on the specified `MemoryStack`.
`int`	`nbActiveWorkers()` Returns the value of the `nbActiveWorkers` field.
`static long`	`nconsumed(long struct)` Unsafe version of `consumed()`.
`static int`	`ncurrentJobID(long struct)` Unsafe version of `currentJobID()`.
`static long`	`nflushed(long struct)` Unsafe version of `flushed()`.
`static long`	`ningested(long struct)` Unsafe version of `ingested()`.
`static int`	`nnbActiveWorkers(long struct)` Unsafe version of `nbActiveWorkers()`.
`static long`	`nproduced(long struct)` Unsafe version of `produced()`.
`long`	`produced()` Returns the value of the `produced` field.
`int`	`sizeof()`

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - 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 Detail
  - ZSTDFrameProgression
```
public ZSTDFrameProgression(java.nio.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 Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - ingested
```
public long ingested()
```
    Returns the value of the ingested field.
  - consumed
```
public long consumed()
```
    Returns the value of the consumed field.
  - produced
```
public long produced()
```
    Returns the value of the produced field.
  - flushed
```
public long flushed()
```
    Returns the value of the flushed field.
  - currentJobID
```
public int currentJobID()
```
    Returns the value of the currentJobID field.
  - nbActiveWorkers
```
public int nbActiveWorkers()
```
    Returns the value of the nbActiveWorkers field.
  - 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
```
@Nullable
public static 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
```
@Nullable
public static ZSTDFrameProgression.Buffer createSafe(long address,
                                                               int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static ZSTDFrameProgression mallocStack()
```
    Returns a new ZSTDFrameProgression instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static ZSTDFrameProgression callocStack()
```
    Returns a new ZSTDFrameProgression instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static ZSTDFrameProgression mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDFrameProgression instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static ZSTDFrameProgression callocStack(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
  - mallocStack
```
public static ZSTDFrameProgression.Buffer mallocStack(int capacity)
```
    Returns a new ZSTDFrameProgression.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static ZSTDFrameProgression.Buffer callocStack(int capacity)
```
    Returns a new ZSTDFrameProgression.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static ZSTDFrameProgression.Buffer mallocStack(int capacity,
                                                      org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDFrameProgression.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static ZSTDFrameProgression.Buffer callocStack(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:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - 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().

Class ZSTDFrameProgression

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

INGESTED

CONSUMED

PRODUCED

FLUSHED

CURRENTJOBID

NBACTIVEWORKERS

Constructor Detail

ZSTDFrameProgression

Method Detail

sizeof

ingested

consumed

produced

flushed

currentJobID

nbActiveWorkers

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ningested

nconsumed

nproduced

nflushed

ncurrentJobID

nnbActiveWorkers