Package org.lwjgl.util.zstd
Class ZSTDFrameProgression
- 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 bufferedconsumed
– nb input bytes actually compressedproduced
– nb of compressed bytes generated and bufferedflushed
– nb of compressed bytes flushed: not provided; can be tracked from caller sidecurrentJobID
– mT only: latest started job nbnbActiveWorkers
– 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 Description static class
ZSTDFrameProgression.Buffer
An array ofZSTDFrameProgression
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
CONSUMED
CURRENTJOBID
FLUSHED
INGESTED
NBACTIVEWORKERS
PRODUCEDThe struct member offsets.static int
SIZEOF
The struct size in bytes.
-
Constructor Summary
Constructors Constructor Description ZSTDFrameProgression(java.nio.ByteBuffer container)
Creates aZSTDFrameProgression
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ZSTDFrameProgression
calloc()
Returns a newZSTDFrameProgression
instance allocated withmemCalloc
.static ZSTDFrameProgression.Buffer
calloc(int capacity)
Returns a newZSTDFrameProgression.Buffer
instance allocated withmemCalloc
.static ZSTDFrameProgression
callocStack()
Returns a newZSTDFrameProgression
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static ZSTDFrameProgression.Buffer
callocStack(int capacity)
Returns a newZSTDFrameProgression.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static ZSTDFrameProgression.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameProgression.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static ZSTDFrameProgression
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameProgression
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.long
consumed()
Returns the value of theconsumed
field.static ZSTDFrameProgression
create()
Returns a newZSTDFrameProgression
instance allocated withBufferUtils
.static ZSTDFrameProgression.Buffer
create(int capacity)
Returns a newZSTDFrameProgression.Buffer
instance allocated withBufferUtils
.static ZSTDFrameProgression
create(long address)
Returns a newZSTDFrameProgression
instance for the specified memory address.static ZSTDFrameProgression.Buffer
create(long address, int capacity)
Create aZSTDFrameProgression.Buffer
instance at the specified memory.static ZSTDFrameProgression
createSafe(long address)
static ZSTDFrameProgression.Buffer
createSafe(long address, int capacity)
int
currentJobID()
Returns the value of thecurrentJobID
field.long
flushed()
Returns the value of theflushed
field.long
ingested()
Returns the value of theingested
field.static ZSTDFrameProgression
malloc()
Returns a newZSTDFrameProgression
instance allocated withmemAlloc
.static ZSTDFrameProgression.Buffer
malloc(int capacity)
Returns a newZSTDFrameProgression.Buffer
instance allocated withmemAlloc
.static ZSTDFrameProgression
mallocStack()
Returns a newZSTDFrameProgression
instance allocated on the thread-localMemoryStack
.static ZSTDFrameProgression.Buffer
mallocStack(int capacity)
Returns a newZSTDFrameProgression.Buffer
instance allocated on the thread-localMemoryStack
.static ZSTDFrameProgression.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameProgression.Buffer
instance allocated on the specifiedMemoryStack
.static ZSTDFrameProgression
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameProgression
instance allocated on the specifiedMemoryStack
.int
nbActiveWorkers()
Returns the value of thenbActiveWorkers
field.static long
nconsumed(long struct)
Unsafe version ofconsumed()
.static int
ncurrentJobID(long struct)
Unsafe version ofcurrentJobID()
.static long
nflushed(long struct)
Unsafe version offlushed()
.static long
ningested(long struct)
Unsafe version ofingested()
.static int
nnbActiveWorkers(long struct)
Unsafe version ofnbActiveWorkers()
.static long
nproduced(long struct)
Unsafe version ofproduced()
.long
produced()
Returns the value of theproduced
field.int
sizeof()
-
-
-
Constructor Detail
-
ZSTDFrameProgression
public ZSTDFrameProgression(java.nio.ByteBuffer container)
Creates aZSTDFrameProgression
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
ingested
public long ingested()
Returns the value of theingested
field.
-
consumed
public long consumed()
Returns the value of theconsumed
field.
-
produced
public long produced()
Returns the value of theproduced
field.
-
flushed
public long flushed()
Returns the value of theflushed
field.
-
currentJobID
public int currentJobID()
Returns the value of thecurrentJobID
field.
-
nbActiveWorkers
public int nbActiveWorkers()
Returns the value of thenbActiveWorkers
field.
-
malloc
public static ZSTDFrameProgression malloc()
Returns a newZSTDFrameProgression
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static ZSTDFrameProgression calloc()
Returns a newZSTDFrameProgression
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static ZSTDFrameProgression create()
Returns a newZSTDFrameProgression
instance allocated withBufferUtils
.
-
create
public static ZSTDFrameProgression create(long address)
Returns a newZSTDFrameProgression
instance for the specified memory address.
-
createSafe
@Nullable public static ZSTDFrameProgression createSafe(long address)
-
malloc
public static ZSTDFrameProgression.Buffer malloc(int capacity)
Returns a newZSTDFrameProgression.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static ZSTDFrameProgression.Buffer calloc(int capacity)
Returns a newZSTDFrameProgression.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static ZSTDFrameProgression.Buffer create(int capacity)
Returns a newZSTDFrameProgression.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static ZSTDFrameProgression.Buffer create(long address, int capacity)
Create aZSTDFrameProgression.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static ZSTDFrameProgression.Buffer createSafe(long address, int capacity)
-
mallocStack
public static ZSTDFrameProgression mallocStack()
Returns a newZSTDFrameProgression
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static ZSTDFrameProgression callocStack()
Returns a newZSTDFrameProgression
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static ZSTDFrameProgression mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameProgression
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static ZSTDFrameProgression callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameProgression
instance allocated on the specifiedMemoryStack
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 newZSTDFrameProgression.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static ZSTDFrameProgression.Buffer callocStack(int capacity)
Returns a newZSTDFrameProgression.Buffer
instance allocated on the thread-localMemoryStack
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 newZSTDFrameProgression.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static ZSTDFrameProgression.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameProgression.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
ningested
public static long ningested(long struct)
Unsafe version ofingested()
.
-
nconsumed
public static long nconsumed(long struct)
Unsafe version ofconsumed()
.
-
nproduced
public static long nproduced(long struct)
Unsafe version ofproduced()
.
-
nflushed
public static long nflushed(long struct)
Unsafe version offlushed()
.
-
ncurrentJobID
public static int ncurrentJobID(long struct)
Unsafe version ofcurrentJobID()
.
-
nnbActiveWorkers
public static int nnbActiveWorkers(long struct)
Unsafe version ofnbActiveWorkers()
.
-
-