Modifier and Type	Class and Description
public static class	LZ4FCustomMem.Buffer An array of `LZ4FCustomMem` 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	CUSTOMCALLOC The struct member offsets.
public static final int	CUSTOMFREE The struct member offsets.
public static final int	OPAQUESTATE The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

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

Method Summary

Modifier and Type	Method and Description
public static LZ4FCustomMem	calloc() Returns a new `LZ4FCustomMem` instance allocated with `memCalloc`.
public static LZ4FCustomMem.Buffer	calloc(int the buffer capacity capacity) Returns a new `LZ4FCustomMem.Buffer` instance allocated with `memCalloc`.
public static LZ4FCustomMem	calloc(MemoryStack the stack from which to allocate stack) Returns a new `LZ4FCustomMem` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static LZ4FCustomMem.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `LZ4FCustomMem.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected LZ4FCustomMem	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 LZ4FCustomMem	create() Returns a new `LZ4FCustomMem` instance allocated with `BufferUtils`.
public static LZ4FCustomMem	create(long address) Returns a new `LZ4FCustomMem` instance for the specified memory address.
public static LZ4FCustomMem.Buffer	create(int the buffer capacity capacity) Returns a new `LZ4FCustomMem.Buffer` instance allocated with `BufferUtils`.
public static LZ4FCustomMem.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `LZ4FCustomMem.Buffer` instance at the specified memory.
public static LZ4FCustomMem	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static LZ4FCustomMem.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public LZ4FAllocFunction	Returns: the value of the `customAlloc` field. customAlloc()
public LZ4FCustomMem	customAlloc(LZ4FAllocFunctionI value) Sets the specified value to the `customAlloc` field.
public LZ4FCallocFunction	customCalloc() optional; when not defined, uses `customAlloc` + `memset`
public LZ4FCustomMem	customCalloc(LZ4FCallocFunctionI value) Sets the specified value to the `customCalloc` field.
public LZ4FFreeFunction	Returns: the value of the `customFree` field. customFree()
public LZ4FCustomMem	customFree(LZ4FFreeFunctionI value) Sets the specified value to the `customFree` field.
public static LZ4FCustomMem	malloc() Returns a new `LZ4FCustomMem` instance allocated with `memAlloc`.
public static LZ4FCustomMem.Buffer	malloc(int the buffer capacity capacity) Returns a new `LZ4FCustomMem.Buffer` instance allocated with `memAlloc`.
public static LZ4FCustomMem	malloc(MemoryStack the stack from which to allocate stack) Returns a new `LZ4FCustomMem` instance allocated on the specified `MemoryStack`.
public static LZ4FCustomMem.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `LZ4FCustomMem.Buffer` instance allocated on the specified `MemoryStack`.
public static LZ4FAllocFunction	ncustomAlloc(long struct) Unsafe version of `customAlloc`.
public static void	ncustomAlloc(long struct, LZ4FAllocFunctionI value) Unsafe version of `customAlloc`.
public static LZ4FCallocFunction	ncustomCalloc(long struct) Unsafe version of `customCalloc`.
public static void	ncustomCalloc(long struct, LZ4FCallocFunctionI value) Unsafe version of `customCalloc`.
public static LZ4FFreeFunction	ncustomFree(long struct) Unsafe version of `customFree`.
public static void	ncustomFree(long struct, LZ4FFreeFunctionI value) Unsafe version of `customFree`.
public static long	nopaqueState(long struct) Unsafe version of `opaqueState`.
public static void	nopaqueState(long struct, long value) Unsafe version of `opaqueState`.
public long	Returns: the value of the `opaqueState` field. opaqueState()
public LZ4FCustomMem	opaqueState(long value) Sets the specified value to the `opaqueState` field.
public LZ4FCustomMem	set(LZ4FAllocFunctionI customAlloc, LZ4FCallocFunctionI customCalloc, LZ4FFreeFunctionI customFree, long opaqueState) Initializes this struct with the specified values.
public LZ4FCustomMem	Returns: this struct set(LZ4FCustomMem 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.

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

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

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

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

Constructor Detail

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

LZ4FCustomMem back to summary

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

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

calloc back to summary

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

public static LZ4FCustomMem.Buffer calloc(int capacity)

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

public static LZ4FCustomMem calloc(MemoryStack stack)

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

Returns a new LZ4FCustomMem.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

create back to summary

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

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

create back to summary

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

public static LZ4FCustomMem.Buffer create(int capacity)

Returns a new LZ4FCustomMem.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static LZ4FCustomMem createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

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

customAlloc	back to summary
public LZ4FCustomMem customAlloc(LZ4FAllocFunctionI value) Sets the specified value to the `customAlloc` field.

customCalloc back to summary

customCalloc	back to summary
public LZ4FCallocFunction customCalloc() optional; when not defined, uses `customAlloc` + `memset` Annotations @Nullable @NativeType:LZ4F_CallocFunction

public LZ4FCallocFunction customCalloc()

optional; when not defined, uses customAlloc + memset

Annotations

@Nullable
@NativeType:LZ4F_CallocFunction

customCalloc	back to summary
public LZ4FCustomMem customCalloc(LZ4FCallocFunctionI value) Sets the specified value to the `customCalloc` field.

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

customFree	back to summary
public LZ4FCustomMem customFree(LZ4FFreeFunctionI value) Sets the specified value to the `customFree` field.

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

malloc back to summary

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

public static LZ4FCustomMem.Buffer malloc(int capacity)

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

public static LZ4FCustomMem malloc(MemoryStack stack)

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

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

Returns a new LZ4FCustomMem.Buffer instance allocated on the specified MemoryStack.

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

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

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

ncustomCalloc back to summary

ncustomCalloc	back to summary
public static LZ4FCallocFunction ncustomCalloc(long struct) Unsafe version of `customCalloc`. Annotations @Nullable

public static LZ4FCallocFunction ncustomCalloc(long struct)

Unsafe version of customCalloc.

Annotations

@Nullable

ncustomCalloc	back to summary
public static void ncustomCalloc(long struct, LZ4FCallocFunctionI value) Unsafe version of `customCalloc`.

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

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

nopaqueState	back to summary
public static long nopaqueState(long struct) Unsafe version of `opaqueState`.

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

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

opaqueState	back to summary
public LZ4FCustomMem opaqueState(long value) Sets the specified value to the `opaqueState` field.

set	back to summary
public LZ4FCustomMem set(LZ4FAllocFunctionI customAlloc, LZ4FCallocFunctionI customCalloc, LZ4FFreeFunctionI customFree, long opaqueState) Initializes this struct with the specified values.

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

set

back to summary

public LZ4FCustomMem set(LZ4FCustomMem src)

Copies the specified struct data to this struct.

Parameters

src:LZ4FCustomMem: the source struct

Returns:LZ4FCustomMem

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.lz4 back to summary

public Class LZ4FCustomMem.Buffer

Class Inheritance

extends StructBuffer<LZ4FCustomMem, LZ4FCustomMem.Buffer>
implements NativeResource

All Implemented Interfaces

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

An array of LZ4FCustomMem structs.

Field Summary

Modifier and Type	Field and Description
private static final LZ4FCustomMem	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `LZ4FCustomMem.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 LZ4FAllocFunction	Returns: the value of the `customAlloc` field. customAlloc()
public LZ4FCustomMem.Buffer	customAlloc(LZ4FAllocFunctionI value) Sets the specified value to the `customAlloc` field.
public LZ4FCallocFunction	Returns: the value of the `LZ4FCustomMem#customCalloc` field. customCalloc()
public LZ4FCustomMem.Buffer	customCalloc(LZ4FCallocFunctionI value) Sets the specified value to the `LZ4FCustomMem#customCalloc` field.
public LZ4FFreeFunction	Returns: the value of the `customFree` field. customFree()
public LZ4FCustomMem.Buffer	customFree(LZ4FFreeFunctionI value) Sets the specified value to the `customFree` field.
protected LZ4FCustomMem	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `opaqueState` field. opaqueState()
public LZ4FCustomMem.Buffer	opaqueState(long value) Sets the specified value to the `opaqueState` field.
protected LZ4FCustomMem.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 LZ4FCustomMem ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new LZ4FCustomMem.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 LZ4FCustomMem#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 LZ4FAllocFunction customAlloc() Returns:LZ4FAllocFunction the value of the `customAlloc` field. Annotations @NativeType:LZ4F_AllocFunction

customAlloc	back to summary
public LZ4FCustomMem.Buffer customAlloc(LZ4FAllocFunctionI value) Sets the specified value to the `customAlloc` field.

customCalloc	back to summary
public LZ4FCallocFunction customCalloc() Returns:LZ4FCallocFunction the value of the `LZ4FCustomMem#customCalloc` field. Annotations @Nullable @NativeType:LZ4F_CallocFunction