ZDICTParams (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class ZDICTParams
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Member documentation
- compressionLevel – optimize for a specific zstd compression level; 0 means default
- notificationLevel – write log to stderr; 0 = none (default); 1 = errors; 2 = progression; 3 = details; 4 = debug;
- dictID – force dictID value; 0 means auto mode (32-bits random value)
Layout
```
 struct ZDICT_params_t {
     int compressionLevel;
     unsigned notificationLevel;
     unsigned dictID;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ZDICTParams.Buffer
An array of ZDICTParams 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`	`ZDICTParams.Buffer` An array of `ZDICTParams` structs.

Field Summary

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

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

Constructors
Constructor and Description
`ZDICTParams(java.nio.ByteBuffer container)` Creates a `ZDICTParams` 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 ZDICTParams`	`calloc()` Returns a new `ZDICTParams` instance allocated with `memCalloc`.
`static ZDICTParams.Buffer`	`calloc(int capacity)` Returns a new `ZDICTParams.Buffer` instance allocated with `memCalloc`.
`static ZDICTParams`	`callocStack()` Returns a new `ZDICTParams` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZDICTParams.Buffer`	`callocStack(int capacity)` Returns a new `ZDICTParams.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZDICTParams.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZDICTParams.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static ZDICTParams`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZDICTParams` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`compressionLevel()` Returns the value of the `compressionLevel` field.
`ZDICTParams`	`compressionLevel(int value)` Sets the specified value to the `compressionLevel` field.
`static ZDICTParams`	`create()` Returns a new `ZDICTParams` instance allocated with `BufferUtils`.
`static ZDICTParams.Buffer`	`create(int capacity)` Returns a new `ZDICTParams.Buffer` instance allocated with `BufferUtils`.
`static ZDICTParams`	`create(long address)` Returns a new `ZDICTParams` instance for the specified memory address.
`static ZDICTParams.Buffer`	`create(long address, int capacity)` Create a `ZDICTParams.Buffer` instance at the specified memory.
`static ZDICTParams`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static ZDICTParams.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`dictID()` Returns the value of the `dictID` field.
`ZDICTParams`	`dictID(int value)` Sets the specified value to the `dictID` field.
`static ZDICTParams`	`malloc()` Returns a new `ZDICTParams` instance allocated with `memAlloc`.
`static ZDICTParams.Buffer`	`malloc(int capacity)` Returns a new `ZDICTParams.Buffer` instance allocated with `memAlloc`.
`static ZDICTParams`	`mallocStack()` Returns a new `ZDICTParams` instance allocated on the thread-local `MemoryStack`.
`static ZDICTParams.Buffer`	`mallocStack(int capacity)` Returns a new `ZDICTParams.Buffer` instance allocated on the thread-local `MemoryStack`.
`static ZDICTParams.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZDICTParams.Buffer` instance allocated on the specified `MemoryStack`.
`static ZDICTParams`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZDICTParams` instance allocated on the specified `MemoryStack`.
`static int`	`ncompressionLevel(long struct)` Unsafe version of `compressionLevel()`.
`static void`	`ncompressionLevel(long struct, int value)` Unsafe version of `compressionLevel`.
`static int`	`ndictID(long struct)` Unsafe version of `dictID()`.
`static void`	`ndictID(long struct, int value)` Unsafe version of `dictID`.
`static int`	`nnotificationLevel(long struct)` Unsafe version of `notificationLevel()`.
`static void`	`nnotificationLevel(long struct, int value)` Unsafe version of `notificationLevel`.
`int`	`notificationLevel()` Returns the value of the `notificationLevel` field.
`ZDICTParams`	`notificationLevel(int value)` Sets the specified value to the `notificationLevel` field.
`ZDICTParams`	`set(int compressionLevel, int notificationLevel, int dictID)` Initializes this struct with the specified values.
`ZDICTParams`	`set(ZDICTParams 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.
  - COMPRESSIONLEVEL
```
public static final int COMPRESSIONLEVEL
```
    The struct member offsets.
  - NOTIFICATIONLEVEL
```
public static final int NOTIFICATIONLEVEL
```
    The struct member offsets.
  - DICTID
```
public static final int DICTID
```
    The struct member offsets.
- Constructor Detail
  - ZDICTParams
```
public ZDICTParams(java.nio.ByteBuffer container)
```
    Creates a ZDICTParams 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
  - compressionLevel
```
public int compressionLevel()
```
    Returns the value of the compressionLevel field.
  - notificationLevel
```
public int notificationLevel()
```
    Returns the value of the notificationLevel field.
  - dictID
```
public int dictID()
```
    Returns the value of the dictID field.
  - compressionLevel
```
public ZDICTParams compressionLevel(int value)
```
    Sets the specified value to the compressionLevel field.
  - notificationLevel
```
public ZDICTParams notificationLevel(int value)
```
    Sets the specified value to the notificationLevel field.
  - dictID
```
public ZDICTParams dictID(int value)
```
    Sets the specified value to the dictID field.
  - set
```
public ZDICTParams set(int compressionLevel,
                       int notificationLevel,
                       int dictID)
```
    Initializes this struct with the specified values.
  - set
```
public ZDICTParams set(ZDICTParams src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static ZDICTParams malloc()
```
    Returns a new ZDICTParams instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static ZDICTParams calloc()
```
    Returns a new ZDICTParams instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static ZDICTParams create()
```
    Returns a new ZDICTParams instance allocated with BufferUtils.
  - create
```
public static ZDICTParams create(long address)
```
    Returns a new ZDICTParams instance for the specified memory address.
  - createSafe
```
@Nullable
public static ZDICTParams createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static ZDICTParams.Buffer malloc(int capacity)
```
    Returns a new ZDICTParams.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static ZDICTParams.Buffer calloc(int capacity)
```
    Returns a new ZDICTParams.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ZDICTParams.Buffer create(int capacity)
```
    Returns a new ZDICTParams.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ZDICTParams.Buffer create(long address,
                                        int capacity)
```
    Create a ZDICTParams.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static ZDICTParams.Buffer createSafe(long address,
                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static ZDICTParams mallocStack()
```
    Returns a new ZDICTParams instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static ZDICTParams callocStack()
```
    Returns a new ZDICTParams instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static ZDICTParams mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZDICTParams instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static ZDICTParams callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZDICTParams instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static ZDICTParams.Buffer mallocStack(int capacity)
```
    Returns a new ZDICTParams.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static ZDICTParams.Buffer callocStack(int capacity)
```
    Returns a new ZDICTParams.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static ZDICTParams.Buffer mallocStack(int capacity,
                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZDICTParams.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static ZDICTParams.Buffer callocStack(int capacity,
                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZDICTParams.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
  - ncompressionLevel
```
public static int ncompressionLevel(long struct)
```
    Unsafe version of compressionLevel().
  - nnotificationLevel
```
public static int nnotificationLevel(long struct)
```
    Unsafe version of notificationLevel().
  - ndictID
```
public static int ndictID(long struct)
```
    Unsafe version of dictID().
  - ncompressionLevel
```
public static void ncompressionLevel(long struct,
                                     int value)
```
    Unsafe version of compressionLevel.
  - nnotificationLevel
```
public static void nnotificationLevel(long struct,
                                      int value)
```
    Unsafe version of notificationLevel.
  - ndictID
```
public static void ndictID(long struct,
                           int value)
```
    Unsafe version of dictID.

Class ZDICTParams

Member documentation

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

COMPRESSIONLEVEL

NOTIFICATIONLEVEL

DICTID

Constructor Detail

ZDICTParams

Method Detail

sizeof

compressionLevel

notificationLevel

dictID

compressionLevel

notificationLevel

dictID

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ncompressionLevel

nnotificationLevel

ndictID

ncompressionLevel

nnotificationLevel

ndictID