Package org.lwjgl.util.lz4

Class LZ4FCompressOptions

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<LZ4FCompressOptions>

org.lwjgl.util.lz4.LZ4FCompressOptions

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class LZ4FCompressOptions
extends Struct<LZ4FCompressOptions>
implements NativeResource

 struct LZ4F_compressOptions_t {
     unsigned stableSrc;
     unsigned reserved[3];
 }

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

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

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
LZ4FCompressOptions(ByteBuffer container)	Creates a LZ4FCompressOptions instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static LZ4FCompressOptions	calloc()	Returns a new LZ4FCompressOptions instance allocated with memCalloc.
static LZ4FCompressOptions.Buffer	calloc(int capacity)	Returns a new LZ4FCompressOptions.Buffer instance allocated with memCalloc.
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.
static LZ4FCompressOptions	calloc(MemoryStack stack)	Returns a new LZ4FCompressOptions instance allocated on the specified MemoryStack and initializes all its bits to zero.
static LZ4FCompressOptions	create()	Returns a new LZ4FCompressOptions instance allocated with BufferUtils.
static LZ4FCompressOptions.Buffer	create(int capacity)	Returns a new LZ4FCompressOptions.Buffer instance allocated with BufferUtils.
static LZ4FCompressOptions	create(long address)	Returns a new LZ4FCompressOptions instance for the specified memory address.
static LZ4FCompressOptions.Buffer	create(long address, int capacity)	Create a LZ4FCompressOptions.Buffer instance at the specified memory.
static @Nullable LZ4FCompressOptions	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable LZ4FCompressOptions.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static LZ4FCompressOptions	malloc()	Returns a new LZ4FCompressOptions instance allocated with memAlloc.
static LZ4FCompressOptions.Buffer	malloc(int capacity)	Returns a new LZ4FCompressOptions.Buffer instance allocated with memAlloc.
static LZ4FCompressOptions.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new LZ4FCompressOptions.Buffer instance allocated on the specified MemoryStack.
static LZ4FCompressOptions	malloc(MemoryStack stack)	Returns a new LZ4FCompressOptions instance allocated on the specified MemoryStack.
static IntBuffer	nreserved(long struct)	Unsafe version of reserved().
static int	nreserved(long struct, int index)	Unsafe version of reserved.
static void	nreserved(long struct, int index, int value)	Unsafe version of reserved.
static void	nreserved(long struct, IntBuffer value)	Unsafe version of reserved.
static int	nstableSrc(long struct)	Unsafe version of stableSrc().
static void	nstableSrc(long struct, int value)	Unsafe version of stableSrc.
IntBuffer	reserved()
int	reserved(int index)
LZ4FCompressOptions	reserved(int index, int value)	Sets the specified value at the specified index of the reserved field.
LZ4FCompressOptions	reserved(IntBuffer value)	Copies the specified IntBuffer to the reserved field.
LZ4FCompressOptions	set(int stableSrc, IntBuffer reserved)	Initializes this struct with the specified values.
LZ4FCompressOptions	set(LZ4FCompressOptions src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	stableSrc()
LZ4FCompressOptions	stableSrc(int value)	Sets the specified value to the stableSrc field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STABLESRC

public static final int STABLESRC

The struct member offsets.

RESERVED

public static final int RESERVED

The struct member offsets.

Constructor Details

LZ4FCompressOptions

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<LZ4FCompressOptions>

stableSrc

public int stableSrc()

Returns:

the value of the stableSrc field.

reserved

public IntBuffer reserved()

Returns:

a IntBuffer view of the reserved field.

reserved

public int reserved(int index)

Returns:

the value at the specified index of the reserved field.

stableSrc

public LZ4FCompressOptions stableSrc(int value)

Sets the specified value to the stableSrc field.

reserved

public LZ4FCompressOptions reserved(IntBuffer value)

Copies the specified IntBuffer to the reserved field.

reserved

public LZ4FCompressOptions reserved(int index,
 int value)

Sets the specified value at the specified index of the reserved field.

set

public LZ4FCompressOptions set(int stableSrc,
 IntBuffer reserved)

Initializes this struct with the specified values.

set

public LZ4FCompressOptions set(LZ4FCompressOptions src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static LZ4FCompressOptions malloc()

Returns a new LZ4FCompressOptions instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static LZ4FCompressOptions calloc()

Returns a new LZ4FCompressOptions instance allocated with memCalloc. The instance must be explicitly freed.

create

public static LZ4FCompressOptions create()

Returns a new LZ4FCompressOptions instance allocated with BufferUtils.

create

public static LZ4FCompressOptions create(long address)

Returns a new LZ4FCompressOptions instance for the specified memory address.

createSafe

public static @Nullable LZ4FCompressOptions createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static LZ4FCompressOptions.Buffer malloc(int capacity)

Returns a new LZ4FCompressOptions.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static LZ4FCompressOptions.Buffer calloc(int capacity)

Returns a new LZ4FCompressOptions.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static LZ4FCompressOptions.Buffer create(int capacity)

Returns a new LZ4FCompressOptions.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a LZ4FCompressOptions.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static LZ4FCompressOptions malloc(MemoryStack stack)

Returns a new LZ4FCompressOptions instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

nstableSrc

public static int nstableSrc(long struct)

Unsafe version of stableSrc().

nreserved

public static IntBuffer nreserved(long struct)

Unsafe version of reserved().

nreserved

public static int nreserved(long struct,
 int index)

Unsafe version of reserved.

nstableSrc

public static void nstableSrc(long struct,
 int value)

Unsafe version of stableSrc.

nreserved

public static void nreserved(long struct,
 IntBuffer value)

Unsafe version of reserved.

nreserved

public static void nreserved(long struct,
 int index,
 int value)

Unsafe version of reserved.