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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	POS The struct member offsets.
public static final int	SIZE The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	SRC The struct member offsets.

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

Method Summary

Modifier and Type	Method and Description
public static ZSTDInBuffer	calloc() Returns a new `ZSTDInBuffer` instance allocated with `memCalloc`.
public static ZSTDInBuffer.Buffer	calloc(int the buffer capacity capacity) Returns a new `ZSTDInBuffer.Buffer` instance allocated with `memCalloc`.
public static ZSTDInBuffer	calloc(MemoryStack the stack from which to allocate stack) Returns a new `ZSTDInBuffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static ZSTDInBuffer.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `ZSTDInBuffer.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static ZSTDInBuffer	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static ZSTDInBuffer	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDInBuffer.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDInBuffer.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected ZSTDInBuffer	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 ZSTDInBuffer	create() Returns a new `ZSTDInBuffer` instance allocated with `BufferUtils`.
public static ZSTDInBuffer	create(long address) Returns a new `ZSTDInBuffer` instance for the specified memory address.
public static ZSTDInBuffer.Buffer	create(int the buffer capacity capacity) Returns a new `ZSTDInBuffer.Buffer` instance allocated with `BufferUtils`.
public static ZSTDInBuffer.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `ZSTDInBuffer.Buffer` instance at the specified memory.
public static ZSTDInBuffer	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static ZSTDInBuffer.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static ZSTDInBuffer	malloc() Returns a new `ZSTDInBuffer` instance allocated with `memAlloc`.
public static ZSTDInBuffer.Buffer	malloc(int the buffer capacity capacity) Returns a new `ZSTDInBuffer.Buffer` instance allocated with `memAlloc`.
public static ZSTDInBuffer	malloc(MemoryStack the stack from which to allocate stack) Returns a new `ZSTDInBuffer` instance allocated on the specified `MemoryStack`.
public static ZSTDInBuffer.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `ZSTDInBuffer.Buffer` instance allocated on the specified `MemoryStack`.
public static ZSTDInBuffer	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static ZSTDInBuffer	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDInBuffer.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDInBuffer.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static long	npos(long struct) Unsafe version of `pos`.
public static void	npos(long struct, long value) Unsafe version of `pos`.
public static long	nsize(long struct) Unsafe version of `size`.
public static void	nsize(long struct, long value) Sets the specified value to the `size` field of the specified `struct`.
public static ByteBuffer	nsrc(long struct) Unsafe version of `src`.
public static void	nsrc(long struct, ByteBuffer value) Unsafe version of `src`.
public long	pos() position where reading stopped.
public ZSTDInBuffer	pos(long value) Sets the specified value to the `pos` field.
public ZSTDInBuffer	set(ByteBuffer src, long pos) Initializes this struct with the specified values.
public ZSTDInBuffer	Returns: this struct set(ZSTDInBuffer the source struct src) Copies the specified struct data to this struct.
public long	size() size of input buffer
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public ByteBuffer	src() start of input buffer
public ZSTDInBuffer	src(ByteBuffer value) Sets the address of the specified `ByteBuffer` to the `src` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.

Field Detail

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

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

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

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

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

Constructor Detail

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

ZSTDInBuffer back to summary

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

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

calloc back to summary

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

public static ZSTDInBuffer.Buffer calloc(int capacity)

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

public static ZSTDInBuffer calloc(MemoryStack stack)

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

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

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

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

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

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

Deprecated

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

Annotations

@Deprecated

create back to summary

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

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

create back to summary

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

public static ZSTDInBuffer.Buffer create(int capacity)

Returns a new ZSTDInBuffer.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static ZSTDInBuffer createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

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

malloc back to summary

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

public static ZSTDInBuffer.Buffer malloc(int capacity)

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

public static ZSTDInBuffer malloc(MemoryStack stack)

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

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

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

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

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

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

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

Deprecated

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

Annotations

@Deprecated

npos	back to summary
public static long npos(long struct) Unsafe version of `pos`.

npos	back to summary
public static void npos(long struct, long value) Unsafe version of `pos`.

nsize	back to summary
public static long nsize(long struct) Unsafe version of `size`.

nsize	back to summary
public static void nsize(long struct, long value) Sets the specified value to the `size` field of the specified `struct`.

nsrc	back to summary
public static ByteBuffer nsrc(long struct) Unsafe version of `src`.

nsrc	back to summary
public static void nsrc(long struct, ByteBuffer value) Unsafe version of `src`.

pos back to summary

pos	back to summary
public long pos() position where reading stopped. Will be updated. Necessarily 0 ≤ `pos` ≤ `size` Annotations @NativeType:size_t

public long pos()

position where reading stopped. Will be updated. Necessarily 0 ≤ pos ≤ size

Annotations

@NativeType:size_t

pos	back to summary
public ZSTDInBuffer pos(long value) Sets the specified value to the `pos` field.

set	back to summary
public ZSTDInBuffer set(ByteBuffer src, long pos) Initializes this struct with the specified values.

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

set

back to summary

public ZSTDInBuffer set(ZSTDInBuffer src)

Copies the specified struct data to this struct.

Parameters

src:ZSTDInBuffer: the source struct

Returns:ZSTDInBuffer

this struct

size	back to summary
public long size() size of input buffer Annotations @NativeType:size_t

size

back to summary

public long size()

size of input buffer

Annotations

@NativeType:size_t

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

src	back to summary
public ByteBuffer src() start of input buffer Annotations @NativeType:void const *

src

back to summary

public ByteBuffer src()

start of input buffer

Annotations

@NativeType:void const *

src	back to summary
public ZSTDInBuffer src(ByteBuffer value) Sets the address of the specified `ByteBuffer` to the `src` field.

validate back to summary

validate	back to summary
public static void validate(long struct) Validates pointer members that should not be `NULL`. Parameters struct:long the struct to validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters

struct:long: the struct to validate

org.lwjgl.util.zstd back to summary

public Class ZSTDInBuffer.Buffer

Class Inheritance

extends StructBuffer<ZSTDInBuffer, ZSTDInBuffer.Buffer>
implements NativeResource

All Implemented Interfaces

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

An array of ZSTDInBuffer structs.

Field Summary

Modifier and Type	Field and Description
private static final ZSTDInBuffer	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `ZSTDInBuffer.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
protected ZSTDInBuffer	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `ZSTDInBuffer#pos` field. pos()
public ZSTDInBuffer.Buffer	pos(long value) Sets the specified value to the `ZSTDInBuffer#pos` field.
protected ZSTDInBuffer.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public long	Returns: the value of the `ZSTDInBuffer#size` field. size()
public ByteBuffer	Returns: a `ByteBuffer` view of the data pointed to by the `ZSTDInBuffer#src` field. src()
public ZSTDInBuffer.Buffer	src(ByteBuffer value) Sets the address of the specified `ByteBuffer` to the `ZSTDInBuffer#src` field.

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

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

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

getElementFactory

back to summary

protected ZSTDInBuffer getElementFactory()

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

Annotations

@Override

pos	back to summary
public long pos() Returns:long the value of the `ZSTDInBuffer#pos` field. Annotations @NativeType:size_t

pos	back to summary
public ZSTDInBuffer.Buffer pos(long value) Sets the specified value to the `ZSTDInBuffer#pos` field.

self

back to summary

protected ZSTDInBuffer.Buffer self()

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

Annotations

@Override

size	back to summary
public long size() Returns:long the value of the `ZSTDInBuffer#size` field. Annotations @NativeType:size_t

src	back to summary
public ByteBuffer src() Returns:ByteBuffer a `ByteBuffer` view of the data pointed to by the `ZSTDInBuffer#src` field. Annotations @NativeType:void const *

src	back to summary
public ZSTDInBuffer.Buffer src(ByteBuffer value) Sets the address of the specified `ByteBuffer` to the `ZSTDInBuffer#src` field.

public Class ZSTDInBuffer

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ZSTDInBuffer.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail