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, NativeResource, Pointer

public class ZSTDFrameProgression
extends Struct<ZSTDFrameProgression>
implements NativeResource

 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 of ZSTDFrameProgression structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CONSUMED	The struct member offsets.
static final int	CURRENTJOBID	The struct member offsets.
static final int	FLUSHED	The struct member offsets.
static final int	INGESTED	The struct member offsets.
static final int	NBACTIVEWORKERS	The struct member offsets.
static final int	PRODUCED	The struct member offsets.
static final 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	Description
ZSTDFrameProgression(ByteBuffer container)	Creates a ZSTDFrameProgression instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new ZSTDFrameProgression.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ZSTDFrameProgression	calloc(MemoryStack stack)	Returns a new ZSTDFrameProgression instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ZSTDFrameProgression	callocStack()	Deprecated.
static ZSTDFrameProgression.Buffer	callocStack(int capacity)	Deprecated.
static ZSTDFrameProgression.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static ZSTDFrameProgression	callocStack(MemoryStack stack)	Deprecated.
long	consumed()
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 @Nullable ZSTDFrameProgression	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable ZSTDFrameProgression.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	currentJobID()
long	flushed()
long	ingested()
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new ZSTDFrameProgression.Buffer instance allocated on the specified MemoryStack.
static ZSTDFrameProgression	malloc(MemoryStack stack)	Returns a new ZSTDFrameProgression instance allocated on the specified MemoryStack.
static ZSTDFrameProgression	mallocStack()	Deprecated.
static ZSTDFrameProgression.Buffer	mallocStack(int capacity)	Deprecated.
static ZSTDFrameProgression.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static ZSTDFrameProgression	mallocStack(MemoryStack stack)	Deprecated.
int	nbActiveWorkers()
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()
int	sizeof()	Returns sizeof(struct).

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<ZSTDFrameProgression>

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

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(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static ZSTDFrameProgression callocStack(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,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static ZSTDFrameProgression.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static ZSTDFrameProgression malloc(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(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,
 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,
 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().