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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	DST The struct member offsets.
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.

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

Method Summary

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

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

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.

Constructor Detail

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

ZSTDOutBuffer back to summary

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

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

calloc back to summary

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

public static ZSTDOutBuffer.Buffer calloc(int capacity)

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

public static ZSTDOutBuffer calloc(MemoryStack stack)

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

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

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

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

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

public static ZSTDOutBuffer.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 ZSTDOutBuffer 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 ZSTDOutBuffer 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 ZSTDOutBuffer create() Returns a new `ZSTDOutBuffer` instance allocated with `BufferUtils`.

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

create back to summary

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

public static ZSTDOutBuffer.Buffer create(int capacity)

Returns a new ZSTDOutBuffer.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static ZSTDOutBuffer createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

dst	back to summary
public ByteBuffer dst() start of output buffer Annotations @NativeType:void *

dst

back to summary

public ByteBuffer dst()

start of output buffer

Annotations

@NativeType:void *

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

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

malloc back to summary

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

public static ZSTDOutBuffer.Buffer malloc(int capacity)

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

public static ZSTDOutBuffer malloc(MemoryStack stack)

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

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

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

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

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

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

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

Deprecated

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

Annotations

@Deprecated

ndst	back to summary
public static ByteBuffer ndst(long struct) Unsafe version of `dst`.

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

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`.

pos back to summary

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

public long pos()

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

Annotations

@NativeType:size_t

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

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

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

set

back to summary

public ZSTDOutBuffer set(ZSTDOutBuffer src)

Copies the specified struct data to this struct.

Parameters

src:ZSTDOutBuffer: the source struct

Returns:ZSTDOutBuffer

this struct

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

size

back to summary

public long size()

size of output 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

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

Class Inheritance

extends StructBuffer<ZSTDOutBuffer, ZSTDOutBuffer.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of ZSTDOutBuffer structs.

Field Summary

Modifier and Type	Field and Description
private static final ZSTDOutBuffer	ELEMENT_FACTORY

Constructor Summary

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

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

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

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

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