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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	CUSTOMALLOC The struct member offsets.
public static final int	CUSTOMFREE The struct member offsets.
public static final int	OPAQUE The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

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

Method Summary

Modifier and Type	Method and Description
public static ZSTDCustomMem	calloc() Returns a new `ZSTDCustomMem` instance allocated with `memCalloc`.
public static ZSTDCustomMem.Buffer	calloc(int the buffer capacity capacity) Returns a new `ZSTDCustomMem.Buffer` instance allocated with `memCalloc`.
public static ZSTDCustomMem	calloc(MemoryStack the stack from which to allocate stack) Returns a new `ZSTDCustomMem` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static ZSTDCustomMem.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `ZSTDCustomMem.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static ZSTDCustomMem	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static ZSTDCustomMem	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDCustomMem.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDCustomMem.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected ZSTDCustomMem	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 ZSTDCustomMem	create() Returns a new `ZSTDCustomMem` instance allocated with `BufferUtils`.
public static ZSTDCustomMem	create(long address) Returns a new `ZSTDCustomMem` instance for the specified memory address.
public static ZSTDCustomMem.Buffer	create(int the buffer capacity capacity) Returns a new `ZSTDCustomMem.Buffer` instance allocated with `BufferUtils`.
public static ZSTDCustomMem.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `ZSTDCustomMem.Buffer` instance at the specified memory.
public static ZSTDCustomMem	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static ZSTDCustomMem.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public ZSTDAllocFunction	Returns: the value of the `customAlloc` field. customAlloc()
public ZSTDCustomMem	customAlloc(ZSTDAllocFunctionI value) Sets the specified value to the `customAlloc` field.
public ZSTDFreeFunction	Returns: the value of the `customFree` field. customFree()
public ZSTDCustomMem	customFree(ZSTDFreeFunctionI value) Sets the specified value to the `customFree` field.
public static ZSTDCustomMem	malloc() Returns a new `ZSTDCustomMem` instance allocated with `memAlloc`.
public static ZSTDCustomMem.Buffer	malloc(int the buffer capacity capacity) Returns a new `ZSTDCustomMem.Buffer` instance allocated with `memAlloc`.
public static ZSTDCustomMem	malloc(MemoryStack the stack from which to allocate stack) Returns a new `ZSTDCustomMem` instance allocated on the specified `MemoryStack`.
public static ZSTDCustomMem.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `ZSTDCustomMem.Buffer` instance allocated on the specified `MemoryStack`.
public static ZSTDCustomMem	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static ZSTDCustomMem	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDCustomMem.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDCustomMem.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static ZSTDAllocFunction	ncustomAlloc(long struct) Unsafe version of `customAlloc`.
public static void	ncustomAlloc(long struct, ZSTDAllocFunctionI value) Unsafe version of `customAlloc`.
public static ZSTDFreeFunction	ncustomFree(long struct) Unsafe version of `customFree`.
public static void	ncustomFree(long struct, ZSTDFreeFunctionI value) Unsafe version of `customFree`.
public static long	nopaque(long struct) Unsafe version of `opaque`.
public static void	nopaque(long struct, long value) Unsafe version of `opaque`.
public long	Returns: the value of the `opaque` field. opaque()
public ZSTDCustomMem	opaque(long value) Sets the specified value to the `opaque` field.
public ZSTDCustomMem	set(ZSTDAllocFunctionI customAlloc, ZSTDFreeFunctionI customFree, long opaque) Initializes this struct with the specified values.
public ZSTDCustomMem	Returns: this struct set(ZSTDCustomMem 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)`.
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.

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

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

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

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

Constructor Detail

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

ZSTDCustomMem back to summary

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

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

calloc back to summary

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

public static ZSTDCustomMem.Buffer calloc(int capacity)

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

public static ZSTDCustomMem calloc(MemoryStack stack)

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

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

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

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

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

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

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

create back to summary

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

public static ZSTDCustomMem.Buffer create(int capacity)

Returns a new ZSTDCustomMem.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static ZSTDCustomMem createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

customAlloc	back to summary
public ZSTDAllocFunction customAlloc() Returns:ZSTDAllocFunction the value of the `customAlloc` field. Annotations @NativeType:ZSTD_allocFunction

customAlloc	back to summary
public ZSTDCustomMem customAlloc(ZSTDAllocFunctionI value) Sets the specified value to the `customAlloc` field.

customFree	back to summary
public ZSTDFreeFunction customFree() Returns:ZSTDFreeFunction the value of the `customFree` field. Annotations @NativeType:ZSTD_freeFunction

customFree	back to summary
public ZSTDCustomMem customFree(ZSTDFreeFunctionI value) Sets the specified value to the `customFree` field.

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

malloc back to summary

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

public static ZSTDCustomMem.Buffer malloc(int capacity)

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

public static ZSTDCustomMem malloc(MemoryStack stack)

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

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

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

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

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

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

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

Deprecated

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

Annotations

@Deprecated

ncustomAlloc	back to summary
public static ZSTDAllocFunction ncustomAlloc(long struct) Unsafe version of `customAlloc`.

ncustomAlloc	back to summary
public static void ncustomAlloc(long struct, ZSTDAllocFunctionI value) Unsafe version of `customAlloc`.

ncustomFree	back to summary
public static ZSTDFreeFunction ncustomFree(long struct) Unsafe version of `customFree`.

ncustomFree	back to summary
public static void ncustomFree(long struct, ZSTDFreeFunctionI value) Unsafe version of `customFree`.

nopaque	back to summary
public static long nopaque(long struct) Unsafe version of `opaque`.

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

opaque	back to summary
public long opaque() Returns:long the value of the `opaque` field. Annotations @NativeType:void *

opaque	back to summary
public ZSTDCustomMem opaque(long value) Sets the specified value to the `opaque` field.

set	back to summary
public ZSTDCustomMem set(ZSTDAllocFunctionI customAlloc, ZSTDFreeFunctionI customFree, long opaque) Initializes this struct with the specified values.

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

set

back to summary

public ZSTDCustomMem set(ZSTDCustomMem src)

Copies the specified struct data to this struct.

Parameters

src:ZSTDCustomMem: the source struct

Returns:ZSTDCustomMem

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

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

Class Inheritance

extends StructBuffer<ZSTDCustomMem, ZSTDCustomMem.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of ZSTDCustomMem structs.

Field Summary

Modifier and Type	Field and Description
private static final ZSTDCustomMem	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `ZSTDCustomMem.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 ZSTDAllocFunction	Returns: the value of the `customAlloc` field. customAlloc()
public ZSTDCustomMem.Buffer	customAlloc(ZSTDAllocFunctionI value) Sets the specified value to the `customAlloc` field.
public ZSTDFreeFunction	Returns: the value of the `customFree` field. customFree()
public ZSTDCustomMem.Buffer	customFree(ZSTDFreeFunctionI value) Sets the specified value to the `customFree` field.
protected ZSTDCustomMem	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `opaque` field. opaque()
public ZSTDCustomMem.Buffer	opaque(long value) Sets the specified value to the `opaque` field.
protected ZSTDCustomMem.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 ZSTDCustomMem ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

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

customAlloc	back to summary
public ZSTDAllocFunction customAlloc() Returns:ZSTDAllocFunction the value of the `customAlloc` field. Annotations @NativeType:ZSTD_allocFunction