Package org.lwjgl.util.zstd

Class ZSTDParameters

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<ZSTDParameters>

org.lwjgl.util.zstd.ZSTDParameters

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class ZSTDParameters
extends Struct<ZSTDParameters>
implements NativeResource

 struct ZSTD_parameters {
     {@link ZSTDCompressionParameters ZSTD_compressionParameters} cParams;
     {@link ZSTDFrameParameters ZSTD_frameParameters} fParams;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ZSTDParameters.Buffer	An array of ZSTDParameters 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	CPARAMS	The struct member offsets.
static final int	FPARAMS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ZSTDParameters	calloc()	Returns a new ZSTDParameters instance allocated with memCalloc.
static ZSTDParameters.Buffer	calloc(int capacity)	Returns a new ZSTDParameters.Buffer instance allocated with memCalloc.
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.
static ZSTDParameters	calloc(MemoryStack stack)	Returns a new ZSTDParameters instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ZSTDParameters	callocStack()	Deprecated.
static ZSTDParameters.Buffer	callocStack(int capacity)	Deprecated.
static ZSTDParameters.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static ZSTDParameters	callocStack(MemoryStack stack)	Deprecated.
ZSTDCompressionParameters	cParams()
ZSTDParameters	cParams(Consumer<ZSTDCompressionParameters> consumer)	Passes the cParams field to the specified Consumer.
ZSTDParameters	cParams(ZSTDCompressionParameters value)	Copies the specified ZSTDCompressionParameters to the cParams field.
static ZSTDParameters	create()	Returns a new ZSTDParameters instance allocated with BufferUtils.
static ZSTDParameters.Buffer	create(int capacity)	Returns a new ZSTDParameters.Buffer instance allocated with BufferUtils.
static ZSTDParameters	create(long address)	Returns a new ZSTDParameters instance for the specified memory address.
static ZSTDParameters.Buffer	create(long address, int capacity)	Create a ZSTDParameters.Buffer instance at the specified memory.
static @Nullable ZSTDParameters	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable ZSTDParameters.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
ZSTDFrameParameters	fParams()
ZSTDParameters	fParams(Consumer<ZSTDFrameParameters> consumer)	Passes the fParams field to the specified Consumer.
ZSTDParameters	fParams(ZSTDFrameParameters value)	Copies the specified ZSTDFrameParameters to the fParams field.
static ZSTDParameters	malloc()	Returns a new ZSTDParameters instance allocated with memAlloc.
static ZSTDParameters.Buffer	malloc(int capacity)	Returns a new ZSTDParameters.Buffer instance allocated with memAlloc.
static ZSTDParameters.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new ZSTDParameters.Buffer instance allocated on the specified MemoryStack.
static ZSTDParameters	malloc(MemoryStack stack)	Returns a new ZSTDParameters instance allocated on the specified MemoryStack.
static ZSTDParameters	mallocStack()	Deprecated.
static ZSTDParameters.Buffer	mallocStack(int capacity)	Deprecated.
static ZSTDParameters.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static ZSTDParameters	mallocStack(MemoryStack stack)	Deprecated.
static ZSTDCompressionParameters	ncParams(long struct)	Unsafe version of cParams().
static void	ncParams(long struct, ZSTDCompressionParameters value)	Unsafe version of cParams.
static ZSTDFrameParameters	nfParams(long struct)	Unsafe version of fParams().
static void	nfParams(long struct, ZSTDFrameParameters value)	Unsafe version of fParams.
ZSTDParameters	set(ZSTDCompressionParameters cParams, ZSTDFrameParameters fParams)	Initializes this struct with the specified values.
ZSTDParameters	set(ZSTDParameters src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).

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.

CPARAMS

public static final int CPARAMS

The struct member offsets.

FPARAMS

public static final int FPARAMS

The struct member offsets.

Constructor Details

ZSTDParameters

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<ZSTDParameters>

cParams

public ZSTDCompressionParameters cParams()

Returns:

a ZSTDCompressionParameters view of the cParams field.

fParams

public ZSTDFrameParameters fParams()

Returns:

a ZSTDFrameParameters view of the fParams field.

cParams

public ZSTDParameters cParams(ZSTDCompressionParameters value)

Copies the specified ZSTDCompressionParameters to the cParams field.

cParams

public ZSTDParameters cParams(Consumer<ZSTDCompressionParameters> consumer)

Passes the cParams field to the specified Consumer.

fParams

public ZSTDParameters fParams(ZSTDFrameParameters value)

Copies the specified ZSTDFrameParameters to the fParams field.

fParams

public ZSTDParameters fParams(Consumer<ZSTDFrameParameters> consumer)

Passes the fParams field to the specified Consumer.

set

public ZSTDParameters set(ZSTDCompressionParameters cParams,
 ZSTDFrameParameters fParams)

Initializes this struct with the specified values.

set

public ZSTDParameters set(ZSTDParameters src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static ZSTDParameters malloc()

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

calloc

public static ZSTDParameters calloc()

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

create

public static ZSTDParameters create()

Returns a new ZSTDParameters instance allocated with BufferUtils.

create

public static ZSTDParameters create(long address)

Returns a new ZSTDParameters instance for the specified memory address.

createSafe

public static @Nullable ZSTDParameters createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static ZSTDParameters.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static ZSTDParameters.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static ZSTDParameters.Buffer create(int capacity)

Returns a new ZSTDParameters.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a ZSTDParameters.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static ZSTDParameters mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static ZSTDParameters callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static ZSTDParameters mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static ZSTDParameters callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static ZSTDParameters.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static ZSTDParameters.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static ZSTDParameters malloc(MemoryStack stack)

Returns a new ZSTDParameters instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

stack - the stack from which to allocate

ncParams

public static ZSTDCompressionParameters ncParams(long struct)

Unsafe version of cParams().

nfParams

public static ZSTDFrameParameters nfParams(long struct)

Unsafe version of fParams().

ncParams

public static void ncParams(long struct,
 ZSTDCompressionParameters value)

Unsafe version of cParams.

nfParams

public static void nfParams(long struct,
 ZSTDFrameParameters value)

Unsafe version of fParams.