Modifier and Type	Class and Description
public static class	ZDICTParams.Buffer An array of `ZDICTParams` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	COMPRESSIONLEVEL The struct member offsets.
public static final int	DICTID The struct member offsets.
public static final int	NOTIFICATIONLEVEL The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

Access	Constructor and Description
protected	ZDICTParams(long address, ByteBuffer container)
public	ZDICTParams(ByteBuffer container) Creates a `ZDICTParams` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static ZDICTParams	calloc() Returns a new `ZDICTParams` instance allocated with `memCalloc`.
public static ZDICTParams.Buffer	calloc(int the buffer capacity capacity) Returns a new `ZDICTParams.Buffer` instance allocated with `memCalloc`.
public static ZDICTParams	calloc(MemoryStack the stack from which to allocate stack) Returns a new `ZDICTParams` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static ZDICTParams.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `ZDICTParams.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static ZDICTParams	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static ZDICTParams	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static ZDICTParams.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static ZDICTParams.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public int	compressionLevel() optimize for a specific zstd compression level; 0 means default
public ZDICTParams	compressionLevel(int value) Sets the specified value to the `compressionLevel` field.
protected ZDICTParams	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 ZDICTParams	create() Returns a new `ZDICTParams` instance allocated with `BufferUtils`.
public static ZDICTParams	create(long address) Returns a new `ZDICTParams` instance for the specified memory address.
public static ZDICTParams.Buffer	create(int the buffer capacity capacity) Returns a new `ZDICTParams.Buffer` instance allocated with `BufferUtils`.
public static ZDICTParams.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `ZDICTParams.Buffer` instance at the specified memory.
public static ZDICTParams	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static ZDICTParams.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	dictID() force `dictID` value; 0 means auto mode (32-bits random value).
public ZDICTParams	dictID(int value) Sets the specified value to the `dictID` field.
public static ZDICTParams	malloc() Returns a new `ZDICTParams` instance allocated with `memAlloc`.
public static ZDICTParams.Buffer	malloc(int the buffer capacity capacity) Returns a new `ZDICTParams.Buffer` instance allocated with `memAlloc`.
public static ZDICTParams	malloc(MemoryStack the stack from which to allocate stack) Returns a new `ZDICTParams` instance allocated on the specified `MemoryStack`.
public static ZDICTParams.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `ZDICTParams.Buffer` instance allocated on the specified `MemoryStack`.
public static ZDICTParams	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static ZDICTParams	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static ZDICTParams.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static ZDICTParams.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	ncompressionLevel(long struct) Unsafe version of `compressionLevel`.
public static void	ncompressionLevel(long struct, int value) Unsafe version of `compressionLevel`.
public static int	ndictID(long struct) Unsafe version of `dictID`.
public static void	ndictID(long struct, int value) Unsafe version of `dictID`.
public static int	nnotificationLevel(long struct) Unsafe version of `notificationLevel`.
public static void	nnotificationLevel(long struct, int value) Unsafe version of `notificationLevel`.
public int	notificationLevel() write log to `stderr`; 0 = none (default); 1 = errors; 2 = progression; 3 = details; 4 = debug;
public ZDICTParams	notificationLevel(int value) Sets the specified value to the `notificationLevel` field.
public ZDICTParams	set(int compressionLevel, int notificationLevel, int dictID) Initializes this struct with the specified values.
public ZDICTParams	Returns: this struct set(ZDICTParams the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

COMPRESSIONLEVEL	back to summary
public static final int COMPRESSIONLEVEL The struct member offsets.

DICTID	back to summary
public static final int DICTID The struct member offsets.

NOTIFICATIONLEVEL	back to summary
public static final int NOTIFICATIONLEVEL The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

ZDICTParams	back to summary
protected ZDICTParams(long address, ByteBuffer container)

ZDICTParams back to summary

ZDICTParams	back to summary
public ZDICTParams(ByteBuffer container) Creates a `ZDICTParams` 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.

public ZDICTParams(ByteBuffer container)

Creates a ZDICTParams 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

calloc	back to summary
public static ZDICTParams calloc() Returns a new `ZDICTParams` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static ZDICTParams.Buffer calloc(int capacity) Returns a new `ZDICTParams.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static ZDICTParams.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static ZDICTParams calloc(MemoryStack stack) Returns a new `ZDICTParams` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static ZDICTParams calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static ZDICTParams.Buffer calloc(int capacity, MemoryStack stack) Returns a new `ZDICTParams.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

public static ZDICTParams.Buffer calloc(int capacity, MemoryStack stack)

Returns a new ZDICTParams.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

callocStack back to summary

callocStack	back to summary
public static ZDICTParams callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static ZDICTParams callocStack()

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static ZDICTParams callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static ZDICTParams callocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static ZDICTParams.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static ZDICTParams.Buffer callocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static ZDICTParams.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static ZDICTParams.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

compressionLevel	back to summary
public int compressionLevel() optimize for a specific zstd compression level; 0 means default

compressionLevel	back to summary
public ZDICTParams compressionLevel(int value) Sets the specified value to the `compressionLevel` field.

create back to summary

create	back to summary
protected ZDICTParams 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

protected ZDICTParams 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

create	back to summary
public static ZDICTParams create() Returns a new `ZDICTParams` instance allocated with `BufferUtils`.

create	back to summary
public static ZDICTParams create(long address) Returns a new `ZDICTParams` instance for the specified memory address.

create back to summary

create	back to summary
public static ZDICTParams.Buffer create(int capacity) Returns a new `ZDICTParams.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static ZDICTParams.Buffer create(int capacity)

Returns a new ZDICTParams.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static ZDICTParams.Buffer create(long address, int capacity) Create a `ZDICTParams.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static ZDICTParams.Buffer create(long address, int capacity)

Create a ZDICTParams.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static ZDICTParams createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static ZDICTParams createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static ZDICTParams.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

dictID back to summary

dictID	back to summary
public int dictID() force `dictID` value; 0 means auto mode (32-bits random value). Note The zstd format reserves some dictionary IDs for future use. You may use them in private settings, but be warned that they may be used by zstd in a public dictionary registry in the future. These dictionary IDs are: `- low range : ≤ 32767 - high range : ≥ (2^31)` Annotations @NativeType:unsigned

public int dictID()

force dictID value; 0 means auto mode (32-bits random value).

Note

The zstd format reserves some dictionary IDs for future use. You may use them in private settings, but be warned that they may be used by zstd in a public dictionary registry in the future. These dictionary IDs are:


- low range  : ≤ 32767
- high range : ≥ (2^31)

Annotations

@NativeType:unsigned

dictID	back to summary
public ZDICTParams dictID(int value) Sets the specified value to the `dictID` field.

malloc	back to summary
public static ZDICTParams malloc() Returns a new `ZDICTParams` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static ZDICTParams.Buffer malloc(int capacity) Returns a new `ZDICTParams.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static ZDICTParams.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static ZDICTParams malloc(MemoryStack stack) Returns a new `ZDICTParams` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static ZDICTParams malloc(MemoryStack stack)

Returns a new ZDICTParams instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static ZDICTParams.Buffer malloc(int capacity, MemoryStack stack) Returns a new `ZDICTParams.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static ZDICTParams.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static ZDICTParams mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static ZDICTParams mallocStack()

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static ZDICTParams mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static ZDICTParams mallocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static ZDICTParams.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static ZDICTParams.Buffer mallocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static ZDICTParams.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static ZDICTParams.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

ncompressionLevel	back to summary
public static int ncompressionLevel(long struct) Unsafe version of `compressionLevel`.

ncompressionLevel	back to summary
public static void ncompressionLevel(long struct, int value) Unsafe version of `compressionLevel`.

ndictID	back to summary
public static int ndictID(long struct) Unsafe version of `dictID`.

ndictID	back to summary
public static void ndictID(long struct, int value) Unsafe version of `dictID`.

nnotificationLevel	back to summary
public static int nnotificationLevel(long struct) Unsafe version of `notificationLevel`.

nnotificationLevel	back to summary
public static void nnotificationLevel(long struct, int value) Unsafe version of `notificationLevel`.

notificationLevel back to summary

notificationLevel	back to summary
public int notificationLevel() write log to `stderr`; 0 = none (default); 1 = errors; 2 = progression; 3 = details; 4 = debug; Annotations @NativeType:unsigned

public int notificationLevel()

write log to stderr; 0 = none (default); 1 = errors; 2 = progression; 3 = details; 4 = debug;

Annotations

@NativeType:unsigned

notificationLevel	back to summary
public ZDICTParams notificationLevel(int value) Sets the specified value to the `notificationLevel` field.

set	back to summary
public ZDICTParams set(int compressionLevel, int notificationLevel, int dictID) Initializes this struct with the specified values.

set	back to summary
public ZDICTParams set(ZDICTParams src) Copies the specified struct data to this struct. Parameters src:ZDICTParams the source struct Returns:ZDICTParams this struct

set

back to summary

public ZDICTParams set(ZDICTParams src)

Copies the specified struct data to this struct.

Parameters

src:ZDICTParams: the source struct

Returns:ZDICTParams

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

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 ZDICTParams.Buffer

Class Inheritance

extends StructBuffer<ZDICTParams, ZDICTParams.Buffer>
implements NativeResource

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of ZDICTParams structs.

Field Summary

Modifier and Type	Field and Description
private static final ZDICTParams	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `ZDICTParams.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 Type	Method and Description
public int	Returns: the value of the `ZDICTParams#compressionLevel` field. compressionLevel()
public ZDICTParams.Buffer	compressionLevel(int value) Sets the specified value to the `ZDICTParams#compressionLevel` field.
public int	Returns: the value of the `ZDICTParams#dictID` field. dictID()
public ZDICTParams.Buffer	dictID(int value) Sets the specified value to the `ZDICTParams#dictID` field.
protected ZDICTParams	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `ZDICTParams#notificationLevel` field. notificationLevel()
public ZDICTParams.Buffer	notificationLevel(int value) Sets the specified value to the `ZDICTParams#notificationLevel` field.
protected ZDICTParams.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final ZDICTParams ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new ZDICTParams.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 ZDICTParams#SIZEOF, and its mark will be undefined.

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

compressionLevel	back to summary
public int compressionLevel() Returns:int the value of the `ZDICTParams#compressionLevel` field.

compressionLevel	back to summary
public ZDICTParams.Buffer compressionLevel(int value) Sets the specified value to the `ZDICTParams#compressionLevel` field.

dictID	back to summary
public int dictID() Returns:int the value of the `ZDICTParams#dictID` field. Annotations @NativeType:unsigned

dictID	back to summary
public ZDICTParams.Buffer dictID(int value) Sets the specified value to the `ZDICTParams#dictID` field.

getElementFactory

back to summary

protected ZDICTParams getElementFactory()

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

Annotations

@Override

notificationLevel	back to summary
public int notificationLevel() Returns:int the value of the `ZDICTParams#notificationLevel` field. Annotations @NativeType:unsigned

notificationLevel	back to summary
public ZDICTParams.Buffer notificationLevel(int value) Sets the specified value to the `ZDICTParams#notificationLevel` field.

self

back to summary

protected ZDICTParams.Buffer self()

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

Annotations

@Override

public Class ZDICTParams

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ZDICTParams.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail