Top Description Inners Fields Constructors Methods
org.lwjgl.util.zstd

public Class ZSTDFrameProgression

extends Struct<ZSTDFrameProgression>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct ZSTD_frameProgression
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
ZSTDFrameProgression.Buffer

An array of ZSTDFrameProgression structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CONSUMED

The struct member offsets.

public static final int
CURRENTJOBID

The struct member offsets.

public static final int
FLUSHED

The struct member offsets.

public static final int
INGESTED

The struct member offsets.

public static final int
NBACTIVEWORKERS

The struct member offsets.

public static final int
PRODUCED

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
ZSTDFrameProgression(long address, ByteBuffer container)

public
ZSTDFrameProgression(ByteBuffer container)

Creates a ZSTDFrameProgression instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static ZSTDFrameProgression
calloc()

Returns a new ZSTDFrameProgression instance allocated with memCalloc.

public static ZSTDFrameProgression.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new ZSTDFrameProgression.Buffer instance allocated with memCalloc.

public static ZSTDFrameProgression
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new ZSTDFrameProgression instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static ZSTDFrameProgression.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new ZSTDFrameProgression.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static ZSTDFrameProgression
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDFrameProgression
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDFrameProgression.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDFrameProgression.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public long
consumed()

nb input bytes actually compressed

protected ZSTDFrameProgression
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static ZSTDFrameProgression
create()

Returns a new ZSTDFrameProgression instance allocated with BufferUtils.

public static ZSTDFrameProgression
create(long address)

Returns a new ZSTDFrameProgression instance for the specified memory address.

public static ZSTDFrameProgression.Buffer
create(int
the buffer capacity
capacity)

Returns a new ZSTDFrameProgression.Buffer instance allocated with BufferUtils.

public static ZSTDFrameProgression.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a ZSTDFrameProgression.Buffer instance at the specified memory.

public static ZSTDFrameProgression
createSafe(long address)

Like create, but returns null if address is NULL.

public static ZSTDFrameProgression.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
currentJobID()

mT only: latest started job nb

public long
flushed()

nb of compressed bytes flushed: not provided; can be tracked from caller side

public long
ingested()

nb input bytes read and buffered

public static ZSTDFrameProgression
malloc()

Returns a new ZSTDFrameProgression instance allocated with memAlloc.

public static ZSTDFrameProgression.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new ZSTDFrameProgression.Buffer instance allocated with memAlloc.

public static ZSTDFrameProgression
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new ZSTDFrameProgression instance allocated on the specified MemoryStack.

public static ZSTDFrameProgression.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new ZSTDFrameProgression.Buffer instance allocated on the specified MemoryStack.

public static ZSTDFrameProgression
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDFrameProgression
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDFrameProgression.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDFrameProgression.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public int
nbActiveWorkers()

mT only: nb of workers actively compressing at probe time

public static long
nconsumed(long struct)

Unsafe version of consumed.

public static int
ncurrentJobID(long struct)

Unsafe version of currentJobID.

public static long
nflushed(long struct)

Unsafe version of flushed.

public static long
ningested(long struct)

Unsafe version of ingested.

public static int
nnbActiveWorkers(long struct)

Unsafe version of nbActiveWorkers.

public static long
nproduced(long struct)

Unsafe version of produced.

public long
produced()

nb of compressed bytes generated and buffered

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

CONSUMEDback to summary
public static final int CONSUMED

The struct member offsets.

CURRENTJOBIDback to summary
public static final int CURRENTJOBID

The struct member offsets.

FLUSHEDback to summary
public static final int FLUSHED

The struct member offsets.

INGESTEDback to summary
public static final int INGESTED

The struct member offsets.

NBACTIVEWORKERSback to summary
public static final int NBACTIVEWORKERS

The struct member offsets.

PRODUCEDback to summary
public static final int PRODUCED

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

ZSTDFrameProgressionback to summary
protected ZSTDFrameProgression(long address, ByteBuffer container)
ZSTDFrameProgressionback to summary
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 Detail

callocback to summary
public static ZSTDFrameProgression calloc()

Returns a new ZSTDFrameProgression instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static ZSTDFrameProgression.Buffer calloc(int capacity)

Returns a new ZSTDFrameProgression.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static ZSTDFrameProgression calloc(MemoryStack stack)

Returns a new ZSTDFrameProgression instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static ZSTDFrameProgression.Buffer calloc(int capacity, MemoryStack stack)

Returns a new ZSTDFrameProgression.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static ZSTDFrameProgression callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static ZSTDFrameProgression callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static ZSTDFrameProgression.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static ZSTDFrameProgression.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
consumedback to summary
public long consumed()

nb input bytes actually compressed

Annotations
@NativeType:unsigned long long
createback to summary
protected ZSTDFrameProgression create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static ZSTDFrameProgression create()

Returns a new ZSTDFrameProgression instance allocated with BufferUtils.

createback to summary
public static ZSTDFrameProgression create(long address)

Returns a new ZSTDFrameProgression instance for the specified memory address.

createback to summary
public static ZSTDFrameProgression.Buffer create(int capacity)

Returns a new ZSTDFrameProgression.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static ZSTDFrameProgression.Buffer create(long address, int capacity)

Create a ZSTDFrameProgression.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static ZSTDFrameProgression createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static ZSTDFrameProgression.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
currentJobIDback to summary
public int currentJobID()

mT only: latest started job nb

Annotations
@NativeType:unsigned int
flushedback to summary
public long flushed()

nb of compressed bytes flushed: not provided; can be tracked from caller side

Annotations
@NativeType:unsigned long long
ingestedback to summary
public long ingested()

nb input bytes read and buffered

Annotations
@NativeType:unsigned long long
mallocback to summary
public static ZSTDFrameProgression malloc()

Returns a new ZSTDFrameProgression instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static ZSTDFrameProgression.Buffer malloc(int capacity)

Returns a new ZSTDFrameProgression.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static ZSTDFrameProgression malloc(MemoryStack stack)

Returns a new ZSTDFrameProgression instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static ZSTDFrameProgression.Buffer malloc(int capacity, MemoryStack stack)

Returns a new ZSTDFrameProgression.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static ZSTDFrameProgression mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static ZSTDFrameProgression mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static ZSTDFrameProgression.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static ZSTDFrameProgression.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nbActiveWorkersback to summary
public int nbActiveWorkers()

mT only: nb of workers actively compressing at probe time

Annotations
@NativeType:unsigned int
nconsumedback to summary
public static long nconsumed(long struct)

Unsafe version of consumed.

ncurrentJobIDback to summary
public static int ncurrentJobID(long struct)

Unsafe version of currentJobID.

nflushedback to summary
public static long nflushed(long struct)

Unsafe version of flushed.

ningestedback to summary
public static long ningested(long struct)

Unsafe version of ingested.

nnbActiveWorkersback to summary
public static int nnbActiveWorkers(long struct)

Unsafe version of nbActiveWorkers.

nproducedback to summary
public static long nproduced(long struct)

Unsafe version of produced.

producedback to summary
public long produced()

nb of compressed bytes generated and buffered

Annotations
@NativeType:unsigned long long
sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.util.zstd back to summary

public Class ZSTDFrameProgression.Buffer

extends StructBuffer<ZSTDFrameProgression, ZSTDFrameProgression.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of ZSTDFrameProgression structs.

Field Summary

Modifier and TypeField and Description
private static final ZSTDFrameProgression
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new ZSTDFrameProgression.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the ZSTDFrameProgression#consumed field.
consumed()

public int

Returns:

the value of the ZSTDFrameProgression#currentJobID field.
currentJobID()

public long

Returns:

the value of the ZSTDFrameProgression#flushed field.
flushed()

protected ZSTDFrameProgression
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public long

Returns:

the value of the ZSTDFrameProgression#ingested field.
ingested()

public int

Returns:

the value of the ZSTDFrameProgression#nbActiveWorkers field.
nbActiveWorkers()

public long

Returns:

the value of the ZSTDFrameProgression#produced field.
produced()

protected ZSTDFrameProgression.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final ZSTDFrameProgression ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new ZSTDFrameProgression.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by ZSTDFrameProgression#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

consumedback to summary
public long consumed()
Returns:long

the value of the ZSTDFrameProgression#consumed field.

Annotations
@NativeType:unsigned long long
currentJobIDback to summary
public int currentJobID()
Returns:int

the value of the ZSTDFrameProgression#currentJobID field.

Annotations
@NativeType:unsigned int
flushedback to summary
public long flushed()
Returns:long

the value of the ZSTDFrameProgression#flushed field.

Annotations
@NativeType:unsigned long long
getElementFactoryback to summary
protected ZSTDFrameProgression getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
ingestedback to summary
public long ingested()
Returns:long

the value of the ZSTDFrameProgression#ingested field.

Annotations
@NativeType:unsigned long long
nbActiveWorkersback to summary
public int nbActiveWorkers()
Returns:int

the value of the ZSTDFrameProgression#nbActiveWorkers field.

Annotations
@NativeType:unsigned int
producedback to summary
public long produced()
Returns:long

the value of the ZSTDFrameProgression#produced field.

Annotations
@NativeType:unsigned long long
selfback to summary
protected ZSTDFrameProgression.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override