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

Modifier and Type	Field and Description
public static final int	_RESERVED1 The struct member offsets.
public static final int	_RESERVED2 The struct member offsets.
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	BLOCKSIZEMAX The struct member offsets.
public static final int	CHECKSUMFLAG The struct member offsets.
public static final int	DICTID The struct member offsets.
public static final int	FRAMECONTENTSIZE The struct member offsets.
public static final int	FRAMETYPE The struct member offsets.
public static final int	HEADERSIZE The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	WINDOWSIZE The struct member offsets.

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

Method Summary

Modifier and Type	Method and Description
public int	Returns: the value of the `blockSizeMax` field. blockSizeMax()
public static ZSTDFrameHeader	calloc() Returns a new `ZSTDFrameHeader` instance allocated with `memCalloc`.
public static ZSTDFrameHeader.Buffer	calloc(int the buffer capacity capacity) Returns a new `ZSTDFrameHeader.Buffer` instance allocated with `memCalloc`.
public static ZSTDFrameHeader	calloc(MemoryStack the stack from which to allocate stack) Returns a new `ZSTDFrameHeader` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static ZSTDFrameHeader.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `ZSTDFrameHeader.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static ZSTDFrameHeader	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static ZSTDFrameHeader	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDFrameHeader.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDFrameHeader.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public int	Returns: the value of the `checksumFlag` field. checksumFlag()
protected ZSTDFrameHeader	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 ZSTDFrameHeader	create() Returns a new `ZSTDFrameHeader` instance allocated with `BufferUtils`.
public static ZSTDFrameHeader	create(long address) Returns a new `ZSTDFrameHeader` instance for the specified memory address.
public static ZSTDFrameHeader.Buffer	create(int the buffer capacity capacity) Returns a new `ZSTDFrameHeader.Buffer` instance allocated with `BufferUtils`.
public static ZSTDFrameHeader.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `ZSTDFrameHeader.Buffer` instance at the specified memory.
public static ZSTDFrameHeader	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static ZSTDFrameHeader.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	Returns: the value of the `dictID` field. dictID()
public long	frameContentSize() if == `CONTENTSIZE_UNKNOWN`, it means this field is not available.
public int	frameType() if == `skippableFrame`, `frameContentSize` is the size of skippable content
public int	Returns: the value of the `headerSize` field. headerSize()
public static ZSTDFrameHeader	malloc() Returns a new `ZSTDFrameHeader` instance allocated with `memAlloc`.
public static ZSTDFrameHeader.Buffer	malloc(int the buffer capacity capacity) Returns a new `ZSTDFrameHeader.Buffer` instance allocated with `memAlloc`.
public static ZSTDFrameHeader	malloc(MemoryStack the stack from which to allocate stack) Returns a new `ZSTDFrameHeader` instance allocated on the specified `MemoryStack`.
public static ZSTDFrameHeader.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `ZSTDFrameHeader.Buffer` instance allocated on the specified `MemoryStack`.
public static ZSTDFrameHeader	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static ZSTDFrameHeader	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDFrameHeader.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDFrameHeader.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	n_reserved1(long struct)
public static int	n_reserved2(long struct)
public static int	nblockSizeMax(long struct) Unsafe version of `blockSizeMax`.
public static int	nchecksumFlag(long struct) Unsafe version of `checksumFlag`.
public static int	ndictID(long struct) Unsafe version of `dictID`.
public static long	nframeContentSize(long struct) Unsafe version of `frameContentSize`.
public static int	nframeType(long struct) Unsafe version of `frameType`.
public static int	nheaderSize(long struct) Unsafe version of `headerSize`.
public static long	nwindowSize(long struct) Unsafe version of `windowSize`.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public long	windowSize() can be very large, up to ≤ `frameContentSize`

Field Detail

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

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

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

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

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

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

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

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

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

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

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

Constructor Detail

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

ZSTDFrameHeader back to summary

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

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

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

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

calloc back to summary

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

public static ZSTDFrameHeader.Buffer calloc(int capacity)

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

public static ZSTDFrameHeader calloc(MemoryStack stack)

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

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

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

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

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

public static ZSTDFrameHeader.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() Returns:int the value of the `checksumFlag` field. Annotations @NativeType:unsigned int

create back to summary

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

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

create back to summary

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

public static ZSTDFrameHeader.Buffer create(int capacity)

Returns a new ZSTDFrameHeader.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static ZSTDFrameHeader createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

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

frameContentSize back to summary

frameContentSize	back to summary
public long frameContentSize() if == `CONTENTSIZE_UNKNOWN`, it means this field is not available. 0 means "empty" Annotations @NativeType:unsigned long long

public long frameContentSize()

if == CONTENTSIZE_UNKNOWN, it means this field is not available. 0 means "empty"

Annotations

@NativeType:unsigned long long

frameType back to summary

frameType	back to summary
public int frameType() if == `skippableFrame`, `frameContentSize` is the size of skippable content Annotations @NativeType:ZSTD_frameType_e

public int frameType()

if == skippableFrame, frameContentSize is the size of skippable content

Annotations

@NativeType:ZSTD_frameType_e

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

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

malloc back to summary

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

public static ZSTDFrameHeader.Buffer malloc(int capacity)

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

public static ZSTDFrameHeader malloc(MemoryStack stack)

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

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

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

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

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

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

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

Deprecated

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

Annotations

@Deprecated

n_reserved1	back to summary
public static int n_reserved1(long struct)

n_reserved2	back to summary
public static int n_reserved2(long struct)

nblockSizeMax	back to summary
public static int nblockSizeMax(long struct) Unsafe version of `blockSizeMax`.

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

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

nframeContentSize	back to summary
public static long nframeContentSize(long struct) Unsafe version of `frameContentSize`.

nframeType	back to summary
public static int nframeType(long struct) Unsafe version of `frameType`.

nheaderSize	back to summary
public static int nheaderSize(long struct) Unsafe version of `headerSize`.

nwindowSize	back to summary
public static long nwindowSize(long struct) Unsafe version of `windowSize`.

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

windowSize back to summary

public long windowSize()

can be very large, up to ≤ frameContentSize

Annotations

@NativeType:unsigned long long

org.lwjgl.util.zstd back to summary

public Class ZSTDFrameHeader.Buffer

Class Inheritance

extends StructBuffer<ZSTDFrameHeader, ZSTDFrameHeader.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of ZSTDFrameHeader structs.

Field Summary

Modifier and Type	Field and Description
private static final ZSTDFrameHeader	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `ZSTDFrameHeader.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 `blockSizeMax` field. blockSizeMax()
public int	Returns: the value of the `checksumFlag` field. checksumFlag()
public int	Returns: the value of the `dictID` field. dictID()
public long	Returns: the value of the `ZSTDFrameHeader#frameContentSize` field. frameContentSize()
public int	Returns: the value of the `ZSTDFrameHeader#frameType` field. frameType()
protected ZSTDFrameHeader	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `headerSize` field. headerSize()
protected ZSTDFrameHeader.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public long	Returns: the value of the `ZSTDFrameHeader#windowSize` field. windowSize()

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 ZSTDFrameHeader ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

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

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

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

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

frameContentSize	back to summary
public long frameContentSize() Returns:long the value of the `ZSTDFrameHeader#frameContentSize` field. Annotations @NativeType:unsigned long long