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

public Class ZSTDParameters

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

Layout


struct ZSTD_parameters {
    ZSTD_compressionParameters cParams;
    ZSTD_frameParameters fParams;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
ZSTDParameters.Buffer

An array of ZSTDParameters structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CPARAMS

The struct member offsets.

public static final int
FPARAMS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
ZSTDParameters(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static ZSTDParameters
calloc()

Returns a new ZSTDParameters instance allocated with memCalloc.

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

Returns a new ZSTDParameters.Buffer instance allocated with memCalloc.

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

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

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

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

public static ZSTDParameters
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public ZSTDCompressionParameters

Returns:

a ZSTDCompressionParameters view of the cParams field.
cParams()

public ZSTDParameters
cParams(ZSTDCompressionParameters value)

Copies the specified ZSTDCompressionParameters to the cParams field.

public ZSTDParameters
cParams(Consumer<ZSTDCompressionParameters> consumer)

Passes the cParams field to the specified Consumer.

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

Returns a new ZSTDParameters instance allocated with BufferUtils.

public static ZSTDParameters
create(long address)

Returns a new ZSTDParameters instance for the specified memory address.

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

Returns a new ZSTDParameters.Buffer instance allocated with BufferUtils.

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

Create a ZSTDParameters.Buffer instance at the specified memory.

public static ZSTDParameters
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ZSTDFrameParameters

Returns:

a ZSTDFrameParameters view of the fParams field.
fParams()

public ZSTDParameters
fParams(ZSTDFrameParameters value)

Copies the specified ZSTDFrameParameters to the fParams field.

public ZSTDParameters
fParams(Consumer<ZSTDFrameParameters> consumer)

Passes the fParams field to the specified Consumer.

public static ZSTDParameters
malloc()

Returns a new ZSTDParameters instance allocated with memAlloc.

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

Returns a new ZSTDParameters.Buffer instance allocated with memAlloc.

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

Returns a new ZSTDParameters instance allocated on the specified MemoryStack.

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

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

public static ZSTDParameters
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDCompressionParameters
ncParams(long struct)

Unsafe version of cParams.

public static void
ncParams(long struct, ZSTDCompressionParameters value)

Unsafe version of cParams.

public static ZSTDFrameParameters
nfParams(long struct)

Unsafe version of fParams.

public static void
nfParams(long struct, ZSTDFrameParameters value)

Unsafe version of fParams.

public ZSTDParameters
set(ZSTDCompressionParameters cParams, ZSTDFrameParameters fParams)

Initializes this struct with the specified values.

public ZSTDParameters

Returns:

this struct
set(ZSTDParameters
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).
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.

CPARAMSback to summary
public static final int CPARAMS

The struct member offsets.

FPARAMSback to summary
public static final int FPARAMS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

ZSTDParametersback to summary
protected ZSTDParameters(long address, ByteBuffer container)
ZSTDParametersback to summary
public ZSTDParameters(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static ZSTDParameters calloc(MemoryStack stack)

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

Returns a new ZSTDParameters.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 ZSTDParameters callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
cParamsback to summary
public ZSTDCompressionParameters cParams()
Returns:ZSTDCompressionParameters

a ZSTDCompressionParameters view of the cParams field.

Annotations
@NativeType:ZSTD_compressionParameters
cParamsback to summary
public ZSTDParameters cParams(ZSTDCompressionParameters value)

Copies the specified ZSTDCompressionParameters to the cParams field.

cParamsback to summary
public ZSTDParameters cParams(Consumer<ZSTDCompressionParameters> consumer)

Passes the cParams field to the specified Consumer.

createback to summary
protected ZSTDParameters 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 ZSTDParameters create()

Returns a new ZSTDParameters instance allocated with BufferUtils.

createback to summary
public static ZSTDParameters create(long address)

Returns a new ZSTDParameters instance for the specified memory address.

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

Returns a new ZSTDParameters.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a ZSTDParameters.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static ZSTDParameters createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
fParamsback to summary
public ZSTDFrameParameters fParams()
Returns:ZSTDFrameParameters

a ZSTDFrameParameters view of the fParams field.

Annotations
@NativeType:ZSTD_frameParameters
fParamsback to summary
public ZSTDParameters fParams(ZSTDFrameParameters value)

Copies the specified ZSTDFrameParameters to the fParams field.

fParamsback to summary
public ZSTDParameters fParams(Consumer<ZSTDFrameParameters> consumer)

Passes the fParams field to the specified Consumer.

mallocback to summary
public static ZSTDParameters malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static ZSTDParameters malloc(MemoryStack stack)

Returns a new ZSTDParameters instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new ZSTDParameters.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 ZSTDParameters mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ncParamsback to summary
public static ZSTDCompressionParameters ncParams(long struct)

Unsafe version of cParams.

ncParamsback to summary
public static void ncParams(long struct, ZSTDCompressionParameters value)

Unsafe version of cParams.

nfParamsback to summary
public static ZSTDFrameParameters nfParams(long struct)

Unsafe version of fParams.

nfParamsback to summary
public static void nfParams(long struct, ZSTDFrameParameters value)

Unsafe version of fParams.

setback to summary
public ZSTDParameters set(ZSTDCompressionParameters cParams, ZSTDFrameParameters fParams)

Initializes this struct with the specified values.

setback to summary
public ZSTDParameters set(ZSTDParameters src)

Copies the specified struct data to this struct.

Parameters
src:ZSTDParameters

the source struct

Returns:ZSTDParameters

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
org.lwjgl.util.zstd back to summary

public Class ZSTDParameters.Buffer

extends StructBuffer<ZSTDParameters, ZSTDParameters.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of ZSTDParameters structs.

Field Summary

Modifier and TypeField and Description
private static final ZSTDParameters
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

a ZSTDCompressionParameters view of the cParams field.
cParams()

public ZSTDParameters.Buffer
cParams(ZSTDCompressionParameters value)

Copies the specified ZSTDCompressionParameters to the cParams field.

public ZSTDParameters.Buffer
cParams(Consumer<ZSTDCompressionParameters> consumer)

Passes the cParams field to the specified Consumer.

public ZSTDFrameParameters

Returns:

a ZSTDFrameParameters view of the fParams field.
fParams()

public ZSTDParameters.Buffer
fParams(ZSTDFrameParameters value)

Copies the specified ZSTDFrameParameters to the fParams field.

public ZSTDParameters.Buffer
fParams(Consumer<ZSTDFrameParameters> consumer)

Passes the fParams field to the specified Consumer.

protected ZSTDParameters
getElementFactory()

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

protected ZSTDParameters.Buffer
self()

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

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final ZSTDParameters ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new ZSTDParameters.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 ZSTDParameters#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

cParamsback to summary
public ZSTDCompressionParameters cParams()
Returns:ZSTDCompressionParameters

a ZSTDCompressionParameters view of the cParams field.

Annotations
@NativeType:ZSTD_compressionParameters
cParamsback to summary
public ZSTDParameters.Buffer cParams(ZSTDCompressionParameters value)

Copies the specified ZSTDCompressionParameters to the cParams field.

cParamsback to summary
public ZSTDParameters.Buffer cParams(Consumer<ZSTDCompressionParameters> consumer)

Passes the cParams field to the specified Consumer.

fParamsback to summary
public ZSTDFrameParameters fParams()
Returns:ZSTDFrameParameters

a ZSTDFrameParameters view of the fParams field.

Annotations
@NativeType:ZSTD_frameParameters
fParamsback to summary
public ZSTDParameters.Buffer fParams(ZSTDFrameParameters value)

Copies the specified ZSTDFrameParameters to the fParams field.

fParamsback to summary
public ZSTDParameters.Buffer fParams(Consumer<ZSTDFrameParameters> consumer)

Passes the fParams field to the specified Consumer.

getElementFactoryback to summary
protected ZSTDParameters getElementFactory()

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

Annotations
@Override
selfback to summary
protected ZSTDParameters.Buffer self()

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

Annotations
@Override