Top Description Inners Fields Constructors Methods
org.lwjgl.util.zstd

public Class ZSTDCompressionParameters

extends Struct<ZSTDCompressionParameters>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct ZSTD_compressionParameters
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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 and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CHAINLOG

The struct member offsets.

public static final int
HASHLOG

The struct member offsets.

public static final int
MINMATCH

The struct member offsets.

public static final int
SEARCHLOG

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STRATEGY

The struct member offsets.

public static final int
TARGETLENGTH

The struct member offsets.

public static final int
WINDOWLOG

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
ZSTDCompressionParameters(long address, ByteBuffer container)

public
ZSTDCompressionParameters(ByteBuffer container)

Creates a ZSTDCompressionParameters instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static ZSTDCompressionParameters
calloc()

Returns a new ZSTDCompressionParameters instance allocated with memCalloc.

public static ZSTDCompressionParameters.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new ZSTDCompressionParameters.Buffer instance allocated with memCalloc.

public static ZSTDCompressionParameters
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static ZSTDCompressionParameters.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static ZSTDCompressionParameters
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDCompressionParameters
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDCompressionParameters.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDCompressionParameters.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public int
chainLog()

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

public ZSTDCompressionParameters
chainLog(int value)

Sets the specified value to the chainLog field.

protected ZSTDCompressionParameters
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 ZSTDCompressionParameters
create()

Returns a new ZSTDCompressionParameters instance allocated with BufferUtils.

public static ZSTDCompressionParameters
create(long address)

Returns a new ZSTDCompressionParameters instance for the specified memory address.

public static ZSTDCompressionParameters.Buffer
create(int
the buffer capacity
capacity
)

Returns a new ZSTDCompressionParameters.Buffer instance allocated with BufferUtils.

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

Create a ZSTDCompressionParameters.Buffer instance at the specified memory.

public static ZSTDCompressionParameters
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
hashLog()

dispatch table: larger == faster, more memory

public ZSTDCompressionParameters
hashLog(int value)

Sets the specified value to the hashLog field.

public static ZSTDCompressionParameters
malloc()

Returns a new ZSTDCompressionParameters instance allocated with memAlloc.

public static ZSTDCompressionParameters.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new ZSTDCompressionParameters.Buffer instance allocated with memAlloc.

public static ZSTDCompressionParameters
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new ZSTDCompressionParameters instance allocated on the specified MemoryStack.

public static ZSTDCompressionParameters.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static ZSTDCompressionParameters
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDCompressionParameters
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDCompressionParameters.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDCompressionParameters.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public int
minMatch()

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

public ZSTDCompressionParameters
minMatch(int value)

Sets the specified value to the minMatch field.

public static int
nchainLog(long struct)

Unsafe version of chainLog.

public static void
nchainLog(long struct, int value)

Unsafe version of chainLog.

public static int
nhashLog(long struct)

Unsafe version of hashLog.

public static void
nhashLog(long struct, int value)

Unsafe version of hashLog.

public static int
nminMatch(long struct)

Unsafe version of minMatch.

public static void
nminMatch(long struct, int value)

Unsafe version of minMatch.

public static int
nsearchLog(long struct)

Unsafe version of searchLog.

public static void
nsearchLog(long struct, int value)

Unsafe version of searchLog.

public static int
nstrategy(long struct)

Unsafe version of strategy.

public static void
nstrategy(long struct, int value)

Unsafe version of strategy.

public static int
ntargetLength(long struct)

Unsafe version of targetLength.

public static void
ntargetLength(long struct, int value)

Unsafe version of targetLength.

public static int
nwindowLog(long struct)

Unsafe version of windowLog.

public static void
nwindowLog(long struct, int value)

Unsafe version of windowLog.

public int
searchLog()

nb of searches: larger == more compression, slower

public ZSTDCompressionParameters
searchLog(int value)

Sets the specified value to the searchLog field.

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

Initializes this struct with the specified values.

public ZSTDCompressionParameters

Returns:

this struct
set
(ZSTDCompressionParameters
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
strategy()

see ZSTD_strategy definition

public ZSTDCompressionParameters
strategy(int value)

Sets the specified value to the strategy field.

public int
targetLength()

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

public ZSTDCompressionParameters
targetLength(int value)

Sets the specified value to the targetLength field.

public int
windowLog()

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

public ZSTDCompressionParameters
windowLog(int value)

Sets the specified value to the windowLog field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

CHAINLOGback to summary
public static final int CHAINLOG

The struct member offsets.

HASHLOGback to summary
public static final int HASHLOG

The struct member offsets.

MINMATCHback to summary
public static final int MINMATCH

The struct member offsets.

SEARCHLOGback to summary
public static final int SEARCHLOG

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STRATEGYback to summary
public static final int STRATEGY

The struct member offsets.

TARGETLENGTHback to summary
public static final int TARGETLENGTH

The struct member offsets.

WINDOWLOGback to summary
public static final int WINDOWLOG

The struct member offsets.

Constructor Detail

ZSTDCompressionParametersback to summary
protected ZSTDCompressionParameters(long address, ByteBuffer container)
ZSTDCompressionParametersback to summary
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 Detail

callocback to summary
public static ZSTDCompressionParameters calloc()

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

callocback to summary
public static ZSTDCompressionParameters.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static ZSTDCompressionParameters calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static ZSTDCompressionParameters.Buffer calloc(int capacity, MemoryStack stack)

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

callocStackback to summary
public static ZSTDCompressionParameters callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static ZSTDCompressionParameters callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static ZSTDCompressionParameters.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static ZSTDCompressionParameters.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
chainLogback to summary
public int chainLog()

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

Annotations
@NativeType:unsigned int
chainLogback to summary
public ZSTDCompressionParameters chainLog(int value)

Sets the specified value to the chainLog field.

createback to summary
protected ZSTDCompressionParameters 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
createback to summary
public static ZSTDCompressionParameters create()

Returns a new ZSTDCompressionParameters instance allocated with BufferUtils.

createback to summary
public static ZSTDCompressionParameters create(long address)

Returns a new ZSTDCompressionParameters instance for the specified memory address.

createback to summary
public static ZSTDCompressionParameters.Buffer create(int capacity)

Returns a new ZSTDCompressionParameters.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a ZSTDCompressionParameters.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static ZSTDCompressionParameters createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static ZSTDCompressionParameters.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
hashLogback to summary
public int hashLog()

dispatch table: larger == faster, more memory

Annotations
@NativeType:unsigned int
hashLogback to summary
public ZSTDCompressionParameters hashLog(int value)

Sets the specified value to the hashLog field.

mallocback to summary
public static ZSTDCompressionParameters malloc()

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

mallocback to summary
public static ZSTDCompressionParameters.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static ZSTDCompressionParameters malloc(MemoryStack stack)

Returns a new ZSTDCompressionParameters instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static ZSTDCompressionParameters.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static ZSTDCompressionParameters mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static ZSTDCompressionParameters mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static ZSTDCompressionParameters.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static ZSTDCompressionParameters.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
minMatchback to summary
public int minMatch()

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

Annotations
@NativeType:unsigned int
minMatchback to summary
public ZSTDCompressionParameters minMatch(int value)

Sets the specified value to the minMatch field.

nchainLogback to summary
public static int nchainLog(long struct)

Unsafe version of chainLog.

nchainLogback to summary
public static void nchainLog(long struct, int value)

Unsafe version of chainLog.

nhashLogback to summary
public static int nhashLog(long struct)

Unsafe version of hashLog.

nhashLogback to summary
public static void nhashLog(long struct, int value)

Unsafe version of hashLog.

nminMatchback to summary
public static int nminMatch(long struct)

Unsafe version of minMatch.

nminMatchback to summary
public static void nminMatch(long struct, int value)

Unsafe version of minMatch.

nsearchLogback to summary
public static int nsearchLog(long struct)

Unsafe version of searchLog.

nsearchLogback to summary
public static void nsearchLog(long struct, int value)

Unsafe version of searchLog.

nstrategyback to summary
public static int nstrategy(long struct)

Unsafe version of strategy.

nstrategyback to summary
public static void nstrategy(long struct, int value)

Unsafe version of strategy.

ntargetLengthback to summary
public static int ntargetLength(long struct)

Unsafe version of targetLength.

ntargetLengthback to summary
public static void ntargetLength(long struct, int value)

Unsafe version of targetLength.

nwindowLogback to summary
public static int nwindowLog(long struct)

Unsafe version of windowLog.

nwindowLogback to summary
public static void nwindowLog(long struct, int value)

Unsafe version of windowLog.

searchLogback to summary
public int searchLog()

nb of searches: larger == more compression, slower

Annotations
@NativeType:unsigned int
searchLogback to summary
public ZSTDCompressionParameters searchLog(int value)

Sets the specified value to the searchLog field.

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

Initializes this struct with the specified values.

setback to summary
public ZSTDCompressionParameters set(ZSTDCompressionParameters src)

Copies the specified struct data to this struct.

Parameters
src:ZSTDCompressionParameters

the source struct

Returns:ZSTDCompressionParameters

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
strategyback to summary
public int strategy()

see ZSTD_strategy definition

Annotations
@NativeType:ZSTD_strategy
strategyback to summary
public ZSTDCompressionParameters strategy(int value)

Sets the specified value to the strategy field.

targetLengthback to summary
public int targetLength()

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

Annotations
@NativeType:unsigned int
targetLengthback to summary
public ZSTDCompressionParameters targetLength(int value)

Sets the specified value to the targetLength field.

windowLogback to summary
public int windowLog()

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

Annotations
@NativeType:unsigned int
windowLogback to summary
public ZSTDCompressionParameters windowLog(int value)

Sets the specified value to the windowLog field.

org.lwjgl.util.zstd back to summary

public Class ZSTDCompressionParameters.Buffer

extends StructBuffer<ZSTDCompressionParameters, ZSTDCompressionParameters.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of ZSTDCompressionParameters structs.

Field Summary

Modifier and TypeField and Description
private static final ZSTDCompressionParameters

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new ZSTDCompressionParameters.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 TypeMethod and Description
public int

Returns:

the value of the ZSTDCompressionParameters#chainLog field.
chainLog
()

public ZSTDCompressionParameters.Buffer
chainLog(int value)

Sets the specified value to the ZSTDCompressionParameters#chainLog field.

protected ZSTDCompressionParameters
public int

Returns:

the value of the ZSTDCompressionParameters#hashLog field.
hashLog
()

public ZSTDCompressionParameters.Buffer
hashLog(int value)

Sets the specified value to the ZSTDCompressionParameters#hashLog field.

public int

Returns:

the value of the ZSTDCompressionParameters#minMatch field.
minMatch
()

public ZSTDCompressionParameters.Buffer
minMatch(int value)

Sets the specified value to the ZSTDCompressionParameters#minMatch field.

public int

Returns:

the value of the ZSTDCompressionParameters#searchLog field.
searchLog
()

public ZSTDCompressionParameters.Buffer
searchLog(int value)

Sets the specified value to the ZSTDCompressionParameters#searchLog field.

protected ZSTDCompressionParameters.Buffer
public int

Returns:

the value of the ZSTDCompressionParameters#strategy field.
strategy
()

public ZSTDCompressionParameters.Buffer
strategy(int value)

Sets the specified value to the ZSTDCompressionParameters#strategy field.

public int

Returns:

the value of the ZSTDCompressionParameters#targetLength field.
targetLength
()

public ZSTDCompressionParameters.Buffer
targetLength(int value)

Sets the specified value to the ZSTDCompressionParameters#targetLength field.

public int

Returns:

the value of the ZSTDCompressionParameters#windowLog field.
windowLog
()

public ZSTDCompressionParameters.Buffer
windowLog(int value)

Sets the specified value to the ZSTDCompressionParameters#windowLog field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final ZSTDCompressionParameters ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new ZSTDCompressionParameters.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 ZSTDCompressionParameters#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

chainLogback to summary
public int chainLog()
Returns:int

the value of the ZSTDCompressionParameters#chainLog field.

Annotations
@NativeType:unsigned int
chainLogback to summary
public ZSTDCompressionParameters.Buffer chainLog(int value)

Sets the specified value to the ZSTDCompressionParameters#chainLog field.

getElementFactoryback to summary
protected ZSTDCompressionParameters getElementFactory()

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

Annotations
@Override
hashLogback to summary
public int hashLog()
Returns:int

the value of the ZSTDCompressionParameters#hashLog field.

Annotations
@NativeType:unsigned int
hashLogback to summary
public ZSTDCompressionParameters.Buffer hashLog(int value)

Sets the specified value to the ZSTDCompressionParameters#hashLog field.

minMatchback to summary
public int minMatch()
Returns:int

the value of the ZSTDCompressionParameters#minMatch field.

Annotations
@NativeType:unsigned int
minMatchback to summary
public ZSTDCompressionParameters.Buffer minMatch(int value)

Sets the specified value to the ZSTDCompressionParameters#minMatch field.

searchLogback to summary
public int searchLog()
Returns:int

the value of the ZSTDCompressionParameters#searchLog field.

Annotations
@NativeType:unsigned int
searchLogback to summary
public ZSTDCompressionParameters.Buffer searchLog(int value)

Sets the specified value to the ZSTDCompressionParameters#searchLog field.

selfback to summary
protected ZSTDCompressionParameters.Buffer self()

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

Annotations
@Override
strategyback to summary
public int strategy()
Returns:int

the value of the ZSTDCompressionParameters#strategy field.

Annotations
@NativeType:ZSTD_strategy
strategyback to summary
public ZSTDCompressionParameters.Buffer strategy(int value)

Sets the specified value to the ZSTDCompressionParameters#strategy field.

targetLengthback to summary
public int targetLength()
Returns:int

the value of the ZSTDCompressionParameters#targetLength field.

Annotations
@NativeType:unsigned int
targetLengthback to summary
public ZSTDCompressionParameters.Buffer targetLength(int value)

Sets the specified value to the ZSTDCompressionParameters#targetLength field.

windowLogback to summary
public int windowLog()
Returns:int

the value of the ZSTDCompressionParameters#windowLog field.

Annotations
@NativeType:unsigned int
windowLogback to summary
public ZSTDCompressionParameters.Buffer windowLog(int value)

Sets the specified value to the ZSTDCompressionParameters#windowLog field.