ZSTDParameters (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.util.zstd.ZSTDParameters

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class ZSTDParameters
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Layout


 struct ZSTD_parameters {
     ZSTD_compressionParameters cParams;
     ZSTD_frameParameters fParams;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ZSTDParameters.Buffer
An array of ZSTDParameters structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`ZSTDParameters.Buffer` An array of `ZSTDParameters` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`CPARAMS` The struct member offsets.
`static int`	`FPARAMS` The struct member offsets.
`static 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 and Description

ZSTDParameters(java.nio.ByteBuffer container)
Creates a ZSTDParameters instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`ZSTDParameters(java.nio.ByteBuffer container)` Creates a `ZSTDParameters` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`callocStack()` Returns a new `ZSTDParameters` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZSTDParameters.Buffer`	`callocStack(int capacity)` Returns a new `ZSTDParameters.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZSTDParameters.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDParameters.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static ZSTDParameters`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDParameters` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`ZSTDCompressionParameters`	`cParams()` Returns a `ZSTDCompressionParameters` view of the `cParams` field.
`ZSTDParameters`	`cParams(java.util.function.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 ZSTDParameters`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static ZSTDParameters.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`ZSTDFrameParameters`	`fParams()` Returns a `ZSTDFrameParameters` view of the `fParams` field.
`ZSTDParameters`	`fParams(java.util.function.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`	`mallocStack()` Returns a new `ZSTDParameters` instance allocated on the thread-local `MemoryStack`.
`static ZSTDParameters.Buffer`	`mallocStack(int capacity)` Returns a new `ZSTDParameters.Buffer` instance allocated on the thread-local `MemoryStack`.
`static ZSTDParameters.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDParameters.Buffer` instance allocated on the specified `MemoryStack`.
`static ZSTDParameters`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDParameters` instance allocated on the specified `MemoryStack`.
`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()`

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
  - 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 Detail
  - ZSTDParameters
```
public ZSTDParameters(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - 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(java.util.function.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(java.util.function.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
```
@Nullable
public static 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
```
@Nullable
public static ZSTDParameters.Buffer createSafe(long address,
                                                         int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static ZSTDParameters mallocStack()
```
    Returns a new ZSTDParameters instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static ZSTDParameters callocStack()
```
    Returns a new ZSTDParameters instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static ZSTDParameters mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDParameters instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static ZSTDParameters callocStack(org.lwjgl.system.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
  - mallocStack
```
public static ZSTDParameters.Buffer mallocStack(int capacity)
```
    Returns a new ZSTDParameters.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static ZSTDParameters.Buffer callocStack(int capacity)
```
    Returns a new ZSTDParameters.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static ZSTDParameters.Buffer mallocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDParameters.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static ZSTDParameters.Buffer callocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDParameters.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - 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.

Class ZSTDParameters

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

CPARAMS

FPARAMS

Constructor Detail

ZSTDParameters

Method Detail

sizeof

cParams

fParams

cParams

cParams

fParams

fParams

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ncParams

nfParams

ncParams

nfParams