ZSTDFrameParameters (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class ZSTDFrameParameters
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Member documentation
- contentSizeFlag – 1: content size will be in frame header (when known)
- checksumFlag – 1: generate a 32-bits checksum using XXH64 algorithm at end of frame, for error detection
- noDictIDFlag – 1: no dictID will be saved into frame header (dictID is only useful for dictionary compression)
Layout
```
 struct ZSTD_frameParameters {
     int contentSizeFlag;
     int checksumFlag;
     int noDictIDFlag;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`CHECKSUMFLAG` The struct member offsets.
`static int`	`CONTENTSIZEFLAG` The struct member offsets.
`static int`	`NODICTIDFLAG` 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
`ZSTDFrameParameters(java.nio.ByteBuffer container)` Creates a `ZSTDFrameParameters` 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 ZSTDFrameParameters`	`calloc()` Returns a new `ZSTDFrameParameters` instance allocated with `memCalloc`.
`static ZSTDFrameParameters.Buffer`	`calloc(int capacity)` Returns a new `ZSTDFrameParameters.Buffer` instance allocated with `memCalloc`.
`static ZSTDFrameParameters`	`callocStack()` Returns a new `ZSTDFrameParameters` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZSTDFrameParameters.Buffer`	`callocStack(int capacity)` Returns a new `ZSTDFrameParameters.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZSTDFrameParameters.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDFrameParameters.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static ZSTDFrameParameters`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDFrameParameters` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`checksumFlag()` Returns the value of the `checksumFlag` field.
`ZSTDFrameParameters`	`checksumFlag(int value)` Sets the specified value to the `checksumFlag` field.
`int`	`contentSizeFlag()` Returns the value of the `contentSizeFlag` field.
`ZSTDFrameParameters`	`contentSizeFlag(int value)` Sets the specified value to the `contentSizeFlag` field.
`static ZSTDFrameParameters`	`create()` Returns a new `ZSTDFrameParameters` instance allocated with `BufferUtils`.
`static ZSTDFrameParameters.Buffer`	`create(int capacity)` Returns a new `ZSTDFrameParameters.Buffer` instance allocated with `BufferUtils`.
`static ZSTDFrameParameters`	`create(long address)` Returns a new `ZSTDFrameParameters` instance for the specified memory address.
`static ZSTDFrameParameters.Buffer`	`create(long address, int capacity)` Create a `ZSTDFrameParameters.Buffer` instance at the specified memory.
`static ZSTDFrameParameters`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static ZSTDFrameParameters.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static ZSTDFrameParameters`	`malloc()` Returns a new `ZSTDFrameParameters` instance allocated with `memAlloc`.
`static ZSTDFrameParameters.Buffer`	`malloc(int capacity)` Returns a new `ZSTDFrameParameters.Buffer` instance allocated with `memAlloc`.
`static ZSTDFrameParameters`	`mallocStack()` Returns a new `ZSTDFrameParameters` instance allocated on the thread-local `MemoryStack`.
`static ZSTDFrameParameters.Buffer`	`mallocStack(int capacity)` Returns a new `ZSTDFrameParameters.Buffer` instance allocated on the thread-local `MemoryStack`.
`static ZSTDFrameParameters.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDFrameParameters.Buffer` instance allocated on the specified `MemoryStack`.
`static ZSTDFrameParameters`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDFrameParameters` instance allocated on the specified `MemoryStack`.
`static int`	`nchecksumFlag(long struct)` Unsafe version of `checksumFlag()`.
`static void`	`nchecksumFlag(long struct, int value)` Unsafe version of `checksumFlag`.
`static int`	`ncontentSizeFlag(long struct)` Unsafe version of `contentSizeFlag()`.
`static void`	`ncontentSizeFlag(long struct, int value)` Unsafe version of `contentSizeFlag`.
`static int`	`nnoDictIDFlag(long struct)` Unsafe version of `noDictIDFlag()`.
`static void`	`nnoDictIDFlag(long struct, int value)` Unsafe version of `noDictIDFlag`.
`int`	`noDictIDFlag()` Returns the value of the `noDictIDFlag` field.
`ZSTDFrameParameters`	`noDictIDFlag(int value)` Sets the specified value to the `noDictIDFlag` field.
`ZSTDFrameParameters`	`set(int contentSizeFlag, int checksumFlag, int noDictIDFlag)` Initializes this struct with the specified values.
`ZSTDFrameParameters`	`set(ZSTDFrameParameters 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.
  - CONTENTSIZEFLAG
```
public static final int CONTENTSIZEFLAG
```
    The struct member offsets.
  - CHECKSUMFLAG
```
public static final int CHECKSUMFLAG
```
    The struct member offsets.
  - NODICTIDFLAG
```
public static final int NODICTIDFLAG
```
    The struct member offsets.
- Constructor Detail
  - ZSTDFrameParameters
```
public ZSTDFrameParameters(java.nio.ByteBuffer container)
```
    Creates a ZSTDFrameParameters 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
  - contentSizeFlag
```
public int contentSizeFlag()
```
    Returns the value of the contentSizeFlag field.
  - checksumFlag
```
public int checksumFlag()
```
    Returns the value of the checksumFlag field.
  - noDictIDFlag
```
public int noDictIDFlag()
```
    Returns the value of the noDictIDFlag field.
  - contentSizeFlag
```
public ZSTDFrameParameters contentSizeFlag(int value)
```
    Sets the specified value to the contentSizeFlag field.
  - checksumFlag
```
public ZSTDFrameParameters checksumFlag(int value)
```
    Sets the specified value to the checksumFlag field.
  - noDictIDFlag
```
public ZSTDFrameParameters noDictIDFlag(int value)
```
    Sets the specified value to the noDictIDFlag field.
  - set
```
public ZSTDFrameParameters set(int contentSizeFlag,
                               int checksumFlag,
                               int noDictIDFlag)
```
    Initializes this struct with the specified values.
  - set
```
public ZSTDFrameParameters set(ZSTDFrameParameters src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static ZSTDFrameParameters malloc()
```
    Returns a new ZSTDFrameParameters instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static ZSTDFrameParameters calloc()
```
    Returns a new ZSTDFrameParameters instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static ZSTDFrameParameters create()
```
    Returns a new ZSTDFrameParameters instance allocated with BufferUtils.
  - create
```
public static ZSTDFrameParameters create(long address)
```
    Returns a new ZSTDFrameParameters instance for the specified memory address.
  - createSafe
```
@Nullable
public static ZSTDFrameParameters createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static ZSTDFrameParameters.Buffer malloc(int capacity)
```
    Returns a new ZSTDFrameParameters.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static ZSTDFrameParameters.Buffer calloc(int capacity)
```
    Returns a new ZSTDFrameParameters.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ZSTDFrameParameters.Buffer create(int capacity)
```
    Returns a new ZSTDFrameParameters.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ZSTDFrameParameters.Buffer create(long address,
                                                int capacity)
```
    Create a ZSTDFrameParameters.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static ZSTDFrameParameters.Buffer createSafe(long address,
                                                              int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static ZSTDFrameParameters mallocStack()
```
    Returns a new ZSTDFrameParameters instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static ZSTDFrameParameters callocStack()
```
    Returns a new ZSTDFrameParameters instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static ZSTDFrameParameters mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDFrameParameters instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static ZSTDFrameParameters callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDFrameParameters instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static ZSTDFrameParameters.Buffer mallocStack(int capacity)
```
    Returns a new ZSTDFrameParameters.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static ZSTDFrameParameters.Buffer callocStack(int capacity)
```
    Returns a new ZSTDFrameParameters.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static ZSTDFrameParameters.Buffer mallocStack(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDFrameParameters.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static ZSTDFrameParameters.Buffer callocStack(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDFrameParameters.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
  - ncontentSizeFlag
```
public static int ncontentSizeFlag(long struct)
```
    Unsafe version of contentSizeFlag().
  - nchecksumFlag
```
public static int nchecksumFlag(long struct)
```
    Unsafe version of checksumFlag().
  - nnoDictIDFlag
```
public static int nnoDictIDFlag(long struct)
```
    Unsafe version of noDictIDFlag().
  - ncontentSizeFlag
```
public static void ncontentSizeFlag(long struct,
                                    int value)
```
    Unsafe version of contentSizeFlag.
  - nchecksumFlag
```
public static void nchecksumFlag(long struct,
                                 int value)
```
    Unsafe version of checksumFlag.
  - nnoDictIDFlag
```
public static void nnoDictIDFlag(long struct,
                                 int value)
```
    Unsafe version of noDictIDFlag.

Class ZSTDFrameParameters

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

CONTENTSIZEFLAG

CHECKSUMFLAG

NODICTIDFLAG

Constructor Detail

ZSTDFrameParameters

Method Detail

sizeof

contentSizeFlag

checksumFlag

noDictIDFlag

contentSizeFlag

checksumFlag

noDictIDFlag

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ncontentSizeFlag

nchecksumFlag

nnoDictIDFlag

ncontentSizeFlag

nchecksumFlag

nnoDictIDFlag