Package org.lwjgl.util.zstd

Class ZSTDCompressionParameters

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<ZSTDCompressionParameters>

org.lwjgl.util.zstd.ZSTDCompressionParameters

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class ZSTDCompressionParameters
extends org.lwjgl.system.Struct<ZSTDCompressionParameters>
implements org.lwjgl.system.NativeResource

Layout

 struct ZSTD_compressionParameters {
     unsigned int windowLog();
     unsigned int chainLog();
     unsigned int hashLog();
     unsigned int searchLog();
     unsigned int minMatch();
     unsigned int targetLength();
     ZSTD_strategy strategy();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CHAINLOG	The struct member offsets.
static final int	HASHLOG	The struct member offsets.
static final int	MINMATCH	The struct member offsets.
static final int	SEARCHLOG	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STRATEGY	The struct member offsets.
static final int	TARGETLENGTH	The struct member offsets.
static final int	WINDOWLOG	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
ZSTDCompressionParameters(ByteBuffer container)	Creates a ZSTDCompressionParameters instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static ZSTDCompressionParameters	calloc()	Returns a new ZSTDCompressionParameters instance allocated with memCalloc.
static ZSTDCompressionParameters.Buffer	calloc(int capacity)	Returns a new ZSTDCompressionParameters.Buffer instance allocated with memCalloc.
static ZSTDCompressionParameters.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new ZSTDCompressionParameters.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ZSTDCompressionParameters	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new ZSTDCompressionParameters instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ZSTDCompressionParameters	callocStack()	Deprecated.
static ZSTDCompressionParameters.Buffer	callocStack(int capacity)	Deprecated.
static ZSTDCompressionParameters.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static ZSTDCompressionParameters	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
int	chainLog()	fully searched segment: larger == more compression, slower, more memory (useless for fast)
ZSTDCompressionParameters	chainLog(int value)	Sets the specified value to the chainLog() field.
static ZSTDCompressionParameters	create()	Returns a new ZSTDCompressionParameters instance allocated with BufferUtils.
static ZSTDCompressionParameters.Buffer	create(int capacity)	Returns a new ZSTDCompressionParameters.Buffer instance allocated with BufferUtils.
static ZSTDCompressionParameters	create(long address)	Returns a new ZSTDCompressionParameters instance for the specified memory address.
static ZSTDCompressionParameters.Buffer	create(long address, int capacity)	Create a ZSTDCompressionParameters.Buffer instance at the specified memory.
static @Nullable ZSTDCompressionParameters	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable ZSTDCompressionParameters.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	hashLog()	dispatch table: larger == faster, more memory
ZSTDCompressionParameters	hashLog(int value)	Sets the specified value to the hashLog() field.
static ZSTDCompressionParameters	malloc()	Returns a new ZSTDCompressionParameters instance allocated with memAlloc.
static ZSTDCompressionParameters.Buffer	malloc(int capacity)	Returns a new ZSTDCompressionParameters.Buffer instance allocated with memAlloc.
static ZSTDCompressionParameters.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new ZSTDCompressionParameters.Buffer instance allocated on the specified MemoryStack.
static ZSTDCompressionParameters	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new ZSTDCompressionParameters instance allocated on the specified MemoryStack.
static ZSTDCompressionParameters	mallocStack()	Deprecated.
static ZSTDCompressionParameters.Buffer	mallocStack(int capacity)	Deprecated.
static ZSTDCompressionParameters.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static ZSTDCompressionParameters	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
int	minMatch()	match length searched: larger == faster decompression, sometimes less compression
ZSTDCompressionParameters	minMatch(int value)	Sets the specified value to the minMatch() field.
static int	nchainLog(long struct)	Unsafe version of chainLog().
static void	nchainLog(long struct, int value)	Unsafe version of chainLog.
static int	nhashLog(long struct)	Unsafe version of hashLog().
static void	nhashLog(long struct, int value)	Unsafe version of hashLog.
static int	nminMatch(long struct)	Unsafe version of minMatch().
static void	nminMatch(long struct, int value)	Unsafe version of minMatch.
static int	nsearchLog(long struct)	Unsafe version of searchLog().
static void	nsearchLog(long struct, int value)	Unsafe version of searchLog.
static int	nstrategy(long struct)	Unsafe version of strategy().
static void	nstrategy(long struct, int value)	Unsafe version of strategy.
static int	ntargetLength(long struct)	Unsafe version of targetLength().
static void	ntargetLength(long struct, int value)	Unsafe version of targetLength.
static int	nwindowLog(long struct)	Unsafe version of windowLog().
static void	nwindowLog(long struct, int value)	Unsafe version of windowLog.
int	searchLog()	nb of searches: larger == more compression, slower
ZSTDCompressionParameters	searchLog(int value)	Sets the specified value to the searchLog() field.
ZSTDCompressionParameters	set(int windowLog, int chainLog, int hashLog, int searchLog, int minMatch, int targetLength, int strategy)	Initializes this struct with the specified values.
ZSTDCompressionParameters	set(ZSTDCompressionParameters src)	Copies the specified struct data to this struct.
int	sizeof()
int	strategy()	see ZSTD_strategy definition
ZSTDCompressionParameters	strategy(int value)	Sets the specified value to the strategy() field.
int	targetLength()	acceptable match size for optimal parser (only): larger == more compression, slower
ZSTDCompressionParameters	targetLength(int value)	Sets the specified value to the targetLength() field.
int	windowLog()	largest match distance: larger == more compression, more memory needed during decompression
ZSTDCompressionParameters	windowLog(int value)	Sets the specified value to the windowLog() 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.

WINDOWLOG

public static final int WINDOWLOG

The struct member offsets.

CHAINLOG

public static final int CHAINLOG

The struct member offsets.

HASHLOG

public static final int HASHLOG

The struct member offsets.

SEARCHLOG

public static final int SEARCHLOG

The struct member offsets.

MINMATCH

public static final int MINMATCH

The struct member offsets.

TARGETLENGTH

public static final int TARGETLENGTH

The struct member offsets.

STRATEGY

public static final int STRATEGY

The struct member offsets.

Constructor Details

ZSTDCompressionParameters

public ZSTDCompressionParameters(ByteBuffer container)

Creates a ZSTDCompressionParameters 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<ZSTDCompressionParameters>

windowLog

public int windowLog()

largest match distance: larger == more compression, more memory needed during decompression

chainLog

public int chainLog()

fully searched segment: larger == more compression, slower, more memory (useless for fast)

hashLog

public int hashLog()

dispatch table: larger == faster, more memory

searchLog

public int searchLog()

nb of searches: larger == more compression, slower

minMatch

public int minMatch()

match length searched: larger == faster decompression, sometimes less compression

targetLength

public int targetLength()

acceptable match size for optimal parser (only): larger == more compression, slower

strategy

public int strategy()

see ZSTD_strategy definition

windowLog

public ZSTDCompressionParameters windowLog(int value)

Sets the specified value to the windowLog() field.

chainLog

public ZSTDCompressionParameters chainLog(int value)

Sets the specified value to the chainLog() field.

hashLog

public ZSTDCompressionParameters hashLog(int value)

Sets the specified value to the hashLog() field.

searchLog

public ZSTDCompressionParameters searchLog(int value)

Sets the specified value to the searchLog() field.

minMatch

public ZSTDCompressionParameters minMatch(int value)

Sets the specified value to the minMatch() field.

targetLength

public ZSTDCompressionParameters targetLength(int value)

Sets the specified value to the targetLength() field.

strategy

public ZSTDCompressionParameters strategy(int value)

Sets the specified value to the strategy() field.

set

public ZSTDCompressionParameters set(int windowLog,
 int chainLog,
 int hashLog,
 int searchLog,
 int minMatch,
 int targetLength,
 int strategy)

Initializes this struct with the specified values.

set

public ZSTDCompressionParameters set(ZSTDCompressionParameters src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static ZSTDCompressionParameters malloc()

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

calloc

public static ZSTDCompressionParameters calloc()

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

create

public static ZSTDCompressionParameters create()

Returns a new ZSTDCompressionParameters instance allocated with BufferUtils.

create

public static ZSTDCompressionParameters create(long address)

Returns a new ZSTDCompressionParameters instance for the specified memory address.

createSafe

public static @Nullable ZSTDCompressionParameters createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static ZSTDCompressionParameters.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static ZSTDCompressionParameters.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static ZSTDCompressionParameters.Buffer create(int capacity)

Returns a new ZSTDCompressionParameters.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a ZSTDCompressionParameters.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static ZSTDCompressionParameters mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static ZSTDCompressionParameters callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static ZSTDCompressionParameters mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static ZSTDCompressionParameters callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static ZSTDCompressionParameters.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static ZSTDCompressionParameters.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static ZSTDCompressionParameters.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static ZSTDCompressionParameters.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static ZSTDCompressionParameters malloc(org.lwjgl.system.MemoryStack stack)

Returns a new ZSTDCompressionParameters instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static ZSTDCompressionParameters calloc(org.lwjgl.system.MemoryStack stack)

Returns a new ZSTDCompressionParameters instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static ZSTDCompressionParameters.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static ZSTDCompressionParameters.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nwindowLog

public static int nwindowLog(long struct)

Unsafe version of windowLog().

nchainLog

public static int nchainLog(long struct)

Unsafe version of chainLog().

nhashLog

public static int nhashLog(long struct)

Unsafe version of hashLog().

nsearchLog

public static int nsearchLog(long struct)

Unsafe version of searchLog().

nminMatch

public static int nminMatch(long struct)

Unsafe version of minMatch().

ntargetLength

public static int ntargetLength(long struct)

Unsafe version of targetLength().

nstrategy

public static int nstrategy(long struct)

Unsafe version of strategy().

nwindowLog

public static void nwindowLog(long struct,
 int value)

Unsafe version of windowLog.

nchainLog

public static void nchainLog(long struct,
 int value)

Unsafe version of chainLog.

nhashLog

public static void nhashLog(long struct,
 int value)

Unsafe version of hashLog.

nsearchLog

public static void nsearchLog(long struct,
 int value)

Unsafe version of searchLog.

nminMatch

public static void nminMatch(long struct,
 int value)

Unsafe version of minMatch.

ntargetLength

public static void ntargetLength(long struct,
 int value)

Unsafe version of targetLength.

nstrategy

public static void nstrategy(long struct,
 int value)

Unsafe version of strategy.