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

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

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

Method Summary

Modifier and Type	Method and Description
public static LZ4FCompressOptions	calloc() Returns a new `LZ4FCompressOptions` instance allocated with `memCalloc`.
public static LZ4FCompressOptions.Buffer	calloc(int the buffer capacity capacity) Returns a new `LZ4FCompressOptions.Buffer` instance allocated with `memCalloc`.
public static LZ4FCompressOptions	calloc(MemoryStack the stack from which to allocate stack) Returns a new `LZ4FCompressOptions` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static LZ4FCompressOptions.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `LZ4FCompressOptions.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static LZ4FCompressOptions	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static LZ4FCompressOptions	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static LZ4FCompressOptions.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static LZ4FCompressOptions.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected LZ4FCompressOptions	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 LZ4FCompressOptions	create() Returns a new `LZ4FCompressOptions` instance allocated with `BufferUtils`.
public static LZ4FCompressOptions	create(long address) Returns a new `LZ4FCompressOptions` instance for the specified memory address.
public static LZ4FCompressOptions.Buffer	create(int the buffer capacity capacity) Returns a new `LZ4FCompressOptions.Buffer` instance allocated with `BufferUtils`.
public static LZ4FCompressOptions.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `LZ4FCompressOptions.Buffer` instance at the specified memory.
public static LZ4FCompressOptions	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static LZ4FCompressOptions.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static LZ4FCompressOptions	malloc() Returns a new `LZ4FCompressOptions` instance allocated with `memAlloc`.
public static LZ4FCompressOptions.Buffer	malloc(int the buffer capacity capacity) Returns a new `LZ4FCompressOptions.Buffer` instance allocated with `memAlloc`.
public static LZ4FCompressOptions	malloc(MemoryStack the stack from which to allocate stack) Returns a new `LZ4FCompressOptions` instance allocated on the specified `MemoryStack`.
public static LZ4FCompressOptions.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `LZ4FCompressOptions.Buffer` instance allocated on the specified `MemoryStack`.
public static LZ4FCompressOptions	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static LZ4FCompressOptions	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static LZ4FCompressOptions.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static LZ4FCompressOptions.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static IntBuffer	nreserved(long struct) Unsafe version of `reserved`.
public static int	nreserved(long struct, int index) Unsafe version of `reserved`.
public static void	nreserved(long struct, IntBuffer value) Unsafe version of `reserved`.
public static void	nreserved(long struct, int index, int value) Unsafe version of `reserved`.
public static int	nstableSrc(long struct) Unsafe version of `stableSrc`.
public static void	nstableSrc(long struct, int value) Unsafe version of `stableSrc`.
public IntBuffer	Returns: a `IntBuffer` view of the `reserved` field. reserved()
public int	Returns: the value at the specified index of the `reserved` field. reserved(int index)
public LZ4FCompressOptions	reserved(IntBuffer value) Copies the specified `IntBuffer` to the `reserved` field.
public LZ4FCompressOptions	reserved(int index, int value) Sets the specified value at the specified index of the `reserved` field.
public LZ4FCompressOptions	set(int stableSrc, IntBuffer reserved) Initializes this struct with the specified values.
public LZ4FCompressOptions	Returns: this struct set(LZ4FCompressOptions 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 int	stableSrc() `1 == src` content will remain present on future calls to `LZ4F_compress()`; skip copying `src` content within `tmp` buffer
public LZ4FCompressOptions	stableSrc(int value) Sets the specified value to the `stableSrc` field.

Field Detail

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

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

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

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

Constructor Detail

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

LZ4FCompressOptions back to summary

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

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

calloc back to summary

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

public static LZ4FCompressOptions.Buffer calloc(int capacity)

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

public static LZ4FCompressOptions calloc(MemoryStack stack)

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

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

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

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

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

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

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

create back to summary

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

public static LZ4FCompressOptions.Buffer create(int capacity)

Returns a new LZ4FCompressOptions.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static LZ4FCompressOptions createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

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

malloc back to summary

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

public static LZ4FCompressOptions.Buffer malloc(int capacity)

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

public static LZ4FCompressOptions malloc(MemoryStack stack)

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

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

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

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

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

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

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

Deprecated

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

Annotations

@Deprecated

nreserved	back to summary
public static IntBuffer nreserved(long struct) Unsafe version of `reserved`.

nreserved	back to summary
public static int nreserved(long struct, int index) Unsafe version of `reserved`.

nreserved	back to summary
public static void nreserved(long struct, IntBuffer value) Unsafe version of `reserved`.

nreserved	back to summary
public static void nreserved(long struct, int index, int value) Unsafe version of `reserved`.

nstableSrc	back to summary
public static int nstableSrc(long struct) Unsafe version of `stableSrc`.

nstableSrc	back to summary
public static void nstableSrc(long struct, int value) Unsafe version of `stableSrc`.

reserved	back to summary
public IntBuffer reserved() Returns:IntBuffer a `IntBuffer` view of the `reserved` field. Annotations @NativeType:unsigned[3]

reserved	back to summary
public int reserved(int index) Returns:int the value at the specified index of the `reserved` field. Annotations @NativeType:unsigned

reserved	back to summary
public LZ4FCompressOptions reserved(IntBuffer value) Copies the specified `IntBuffer` to the `reserved` field.

reserved	back to summary
public LZ4FCompressOptions reserved(int index, int value) Sets the specified value at the specified index of the `reserved` field.

set	back to summary
public LZ4FCompressOptions set(int stableSrc, IntBuffer reserved) Initializes this struct with the specified values.

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

set

back to summary

public LZ4FCompressOptions set(LZ4FCompressOptions src)

Copies the specified struct data to this struct.

Parameters

src:LZ4FCompressOptions: the source struct

Returns:LZ4FCompressOptions

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

stableSrc back to summary

stableSrc	back to summary
public int stableSrc() `1 == src` content will remain present on future calls to `LZ4F_compress()`; skip copying `src` content within `tmp` buffer Annotations @NativeType:unsigned

public int stableSrc()

1 == src content will remain present on future calls to LZ4F_compress(); skip copying src content within tmp buffer

Annotations

@NativeType:unsigned

stableSrc	back to summary
public LZ4FCompressOptions stableSrc(int value) Sets the specified value to the `stableSrc` field.

org.lwjgl.util.lz4 back to summary

public Class LZ4FCompressOptions.Buffer

Class Inheritance

extends StructBuffer<LZ4FCompressOptions, LZ4FCompressOptions.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.util.lz4.LZ4FCompressOptions.Buffer

All Implemented Interfaces

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

An array of LZ4FCompressOptions structs.

Field Summary

Modifier and Type	Field and Description
private static final LZ4FCompressOptions	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `LZ4FCompressOptions.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 LZ4FCompressOptions	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public IntBuffer	Returns: a `IntBuffer` view of the `reserved` field. reserved()
public int	Returns: the value at the specified index of the `reserved` field. reserved(int index)
public LZ4FCompressOptions.Buffer	reserved(IntBuffer value) Copies the specified `IntBuffer` to the `reserved` field.
public LZ4FCompressOptions.Buffer	reserved(int index, int value) Sets the specified value at the specified index of the `reserved` field.
protected LZ4FCompressOptions.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `LZ4FCompressOptions#stableSrc` field. stableSrc()
public LZ4FCompressOptions.Buffer	stableSrc(int value) Sets the specified value to the `LZ4FCompressOptions#stableSrc` 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 LZ4FCompressOptions ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new LZ4FCompressOptions.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 LZ4FCompressOptions#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 LZ4FCompressOptions getElementFactory()

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

Annotations

@Override

reserved	back to summary
public IntBuffer reserved() Returns:IntBuffer a `IntBuffer` view of the `reserved` field. Annotations @NativeType:unsigned[3]

reserved	back to summary
public int reserved(int index) Returns:int the value at the specified index of the `reserved` field. Annotations @NativeType:unsigned

reserved	back to summary
public LZ4FCompressOptions.Buffer reserved(IntBuffer value) Copies the specified `IntBuffer` to the `reserved` field.

reserved	back to summary
public LZ4FCompressOptions.Buffer reserved(int index, int value) Sets the specified value at the specified index of the `reserved` field.

self

back to summary

protected LZ4FCompressOptions.Buffer self()

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

Annotations

@Override

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

stableSrc	back to summary
public LZ4FCompressOptions.Buffer stableSrc(int value) Sets the specified value to the `LZ4FCompressOptions#stableSrc` field.

public Class LZ4FCompressOptions

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class LZ4FCompressOptions.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail