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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	CHECKSUMFLAG The struct member offsets.
public static final int	CONTENTSIZEFLAG The struct member offsets.
public static final int	NODICTIDFLAG The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

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

Method Summary

Modifier and Type	Method and Description
public static ZSTDFrameParameters	calloc() Returns a new `ZSTDFrameParameters` instance allocated with `memCalloc`.
public static ZSTDFrameParameters.Buffer	calloc(int the buffer capacity capacity) Returns a new `ZSTDFrameParameters.Buffer` instance allocated with `memCalloc`.
public static ZSTDFrameParameters	calloc(MemoryStack the stack from which to allocate stack) Returns a new `ZSTDFrameParameters` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static ZSTDFrameParameters.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `ZSTDFrameParameters.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static ZSTDFrameParameters	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static ZSTDFrameParameters	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDFrameParameters.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDFrameParameters.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public int	checksumFlag() 1: generate a 32-bits checksum using XXH64 algorithm at end of frame, for error detection
public ZSTDFrameParameters	checksumFlag(int value) Sets the specified value to the `checksumFlag` field.
public int	contentSizeFlag() 1: content size will be in frame header (when known)
public ZSTDFrameParameters	contentSizeFlag(int value) Sets the specified value to the `contentSizeFlag` field.
protected ZSTDFrameParameters	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 ZSTDFrameParameters	create() Returns a new `ZSTDFrameParameters` instance allocated with `BufferUtils`.
public static ZSTDFrameParameters	create(long address) Returns a new `ZSTDFrameParameters` instance for the specified memory address.
public static ZSTDFrameParameters.Buffer	create(int the buffer capacity capacity) Returns a new `ZSTDFrameParameters.Buffer` instance allocated with `BufferUtils`.
public static ZSTDFrameParameters.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `ZSTDFrameParameters.Buffer` instance at the specified memory.
public static ZSTDFrameParameters	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static ZSTDFrameParameters.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static ZSTDFrameParameters	malloc() Returns a new `ZSTDFrameParameters` instance allocated with `memAlloc`.
public static ZSTDFrameParameters.Buffer	malloc(int the buffer capacity capacity) Returns a new `ZSTDFrameParameters.Buffer` instance allocated with `memAlloc`.
public static ZSTDFrameParameters	malloc(MemoryStack the stack from which to allocate stack) Returns a new `ZSTDFrameParameters` instance allocated on the specified `MemoryStack`.
public static ZSTDFrameParameters.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `ZSTDFrameParameters.Buffer` instance allocated on the specified `MemoryStack`.
public static ZSTDFrameParameters	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static ZSTDFrameParameters	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDFrameParameters.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDFrameParameters.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	nchecksumFlag(long struct) Unsafe version of `checksumFlag`.
public static void	nchecksumFlag(long struct, int value) Unsafe version of `checksumFlag`.
public static int	ncontentSizeFlag(long struct) Unsafe version of `contentSizeFlag`.
public static void	ncontentSizeFlag(long struct, int value) Unsafe version of `contentSizeFlag`.
public static int	nnoDictIDFlag(long struct) Unsafe version of `noDictIDFlag`.
public static void	nnoDictIDFlag(long struct, int value) Unsafe version of `noDictIDFlag`.
public int	noDictIDFlag() 1: no `dictID` will be saved into frame header (`dictID` is only useful for dictionary compression)
public ZSTDFrameParameters	noDictIDFlag(int value) Sets the specified value to the `noDictIDFlag` field.
public ZSTDFrameParameters	set(int contentSizeFlag, int checksumFlag, int noDictIDFlag) Initializes this struct with the specified values.
public ZSTDFrameParameters	Returns: this struct set(ZSTDFrameParameters 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.

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

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

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

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

Constructor Detail

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

ZSTDFrameParameters back to summary

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

Creates a ZSTDFrameParameters 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 ZSTDFrameParameters calloc() Returns a new `ZSTDFrameParameters` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

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

public static ZSTDFrameParameters.Buffer calloc(int capacity)

Returns a new ZSTDFrameParameters.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 ZSTDFrameParameters calloc(MemoryStack stack) Returns a new `ZSTDFrameParameters` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static ZSTDFrameParameters calloc(MemoryStack stack)

Returns a new ZSTDFrameParameters 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 ZSTDFrameParameters.Buffer calloc(int capacity, MemoryStack stack) Returns a new `ZSTDFrameParameters.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 ZSTDFrameParameters.Buffer calloc(int capacity, MemoryStack stack)

Returns a new ZSTDFrameParameters.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 ZSTDFrameParameters callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static ZSTDFrameParameters 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 ZSTDFrameParameters callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static ZSTDFrameParameters 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 ZSTDFrameParameters.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static ZSTDFrameParameters.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 ZSTDFrameParameters.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

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

Deprecated

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

Annotations

@Deprecated

checksumFlag	back to summary
public int checksumFlag() 1: generate a 32-bits checksum using XXH64 algorithm at end of frame, for error detection

checksumFlag	back to summary
public ZSTDFrameParameters checksumFlag(int value) Sets the specified value to the `checksumFlag` field.

contentSizeFlag	back to summary
public int contentSizeFlag() 1: content size will be in frame header (when known)

contentSizeFlag	back to summary
public ZSTDFrameParameters contentSizeFlag(int value) Sets the specified value to the `contentSizeFlag` field.

create back to summary

create	back to summary
protected ZSTDFrameParameters 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 ZSTDFrameParameters 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 ZSTDFrameParameters create() Returns a new `ZSTDFrameParameters` instance allocated with `BufferUtils`.

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

create back to summary

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

public static ZSTDFrameParameters.Buffer create(int capacity)

Returns a new ZSTDFrameParameters.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a ZSTDFrameParameters.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 ZSTDFrameParameters createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static ZSTDFrameParameters createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

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

malloc back to summary

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

public static ZSTDFrameParameters.Buffer malloc(int capacity)

Returns a new ZSTDFrameParameters.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 ZSTDFrameParameters malloc(MemoryStack stack) Returns a new `ZSTDFrameParameters` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static ZSTDFrameParameters malloc(MemoryStack stack)

Returns a new ZSTDFrameParameters 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 ZSTDFrameParameters.Buffer malloc(int capacity, MemoryStack stack) Returns a new `ZSTDFrameParameters.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

Returns a new ZSTDFrameParameters.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 ZSTDFrameParameters mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static ZSTDFrameParameters 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 ZSTDFrameParameters mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static ZSTDFrameParameters 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 ZSTDFrameParameters.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static ZSTDFrameParameters.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 ZSTDFrameParameters.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

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

Deprecated

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

Annotations

@Deprecated

nchecksumFlag	back to summary
public static int nchecksumFlag(long struct) Unsafe version of `checksumFlag`.

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

ncontentSizeFlag	back to summary
public static int ncontentSizeFlag(long struct) Unsafe version of `contentSizeFlag`.

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

nnoDictIDFlag	back to summary
public static int nnoDictIDFlag(long struct) Unsafe version of `noDictIDFlag`.

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

noDictIDFlag	back to summary
public int noDictIDFlag() 1: no `dictID` will be saved into frame header (`dictID` is only useful for dictionary compression)

noDictIDFlag	back to summary
public ZSTDFrameParameters noDictIDFlag(int value) Sets the specified value to the `noDictIDFlag` field.

set	back to summary
public ZSTDFrameParameters set(int contentSizeFlag, int checksumFlag, int noDictIDFlag) Initializes this struct with the specified values.

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

set

back to summary

public ZSTDFrameParameters set(ZSTDFrameParameters src)

Copies the specified struct data to this struct.

Parameters

src:ZSTDFrameParameters: the source struct

Returns:ZSTDFrameParameters

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

Class Inheritance

extends StructBuffer<ZSTDFrameParameters, ZSTDFrameParameters.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.util.zstd.ZSTDFrameParameters.Buffer

All Implemented Interfaces

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

An array of ZSTDFrameParameters structs.

Field Summary

Modifier and Type	Field and Description
private static final ZSTDFrameParameters	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `ZSTDFrameParameters.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 `ZSTDFrameParameters#checksumFlag` field. checksumFlag()
public ZSTDFrameParameters.Buffer	checksumFlag(int value) Sets the specified value to the `ZSTDFrameParameters#checksumFlag` field.
public int	Returns: the value of the `ZSTDFrameParameters#contentSizeFlag` field. contentSizeFlag()
public ZSTDFrameParameters.Buffer	contentSizeFlag(int value) Sets the specified value to the `ZSTDFrameParameters#contentSizeFlag` field.
protected ZSTDFrameParameters	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `ZSTDFrameParameters#noDictIDFlag` field. noDictIDFlag()
public ZSTDFrameParameters.Buffer	noDictIDFlag(int value) Sets the specified value to the `ZSTDFrameParameters#noDictIDFlag` field.
protected ZSTDFrameParameters.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 ZSTDFrameParameters ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new ZSTDFrameParameters.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 ZSTDFrameParameters#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

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

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

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

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

getElementFactory

back to summary

protected ZSTDFrameParameters getElementFactory()

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

Annotations

@Override

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

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

self

back to summary

protected ZSTDFrameParameters.Buffer self()

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

Annotations

@Override

public Class ZSTDFrameParameters

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ZSTDFrameParameters.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail