ZSTDFrameHeader (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class ZSTDFrameHeader
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Member documentation
- frameContentSize – if == CONTENTSIZE_UNKNOWN, it means this field is not available. 0 means "empty"
- windowSize – can be very large, up to ≤ frameContentSize
- frameType – if == skippableFrame, frameContentSize is the size of skippable content
Layout
```
 struct ZSTD_frameHeader {
     unsigned long long frameContentSize;
     unsigned long long windowSize;
     unsigned int blockSizeMax;
     ZSTD_frameType_e frameType;
     unsigned int headerSize;
     unsigned int dictID;
     unsigned int checksumFlag;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`BLOCKSIZEMAX` The struct member offsets.
`static int`	`CHECKSUMFLAG` The struct member offsets.
`static int`	`DICTID` The struct member offsets.
`static int`	`FRAMECONTENTSIZE` The struct member offsets.
`static int`	`FRAMETYPE` The struct member offsets.
`static int`	`HEADERSIZE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`WINDOWSIZE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`ZSTDFrameHeader(java.nio.ByteBuffer container)` Creates a `ZSTDFrameHeader` 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
`int`	`blockSizeMax()` Returns the value of the `blockSizeMax` field.
`static ZSTDFrameHeader`	`calloc()` Returns a new `ZSTDFrameHeader` instance allocated with `memCalloc`.
`static ZSTDFrameHeader.Buffer`	`calloc(int capacity)` Returns a new `ZSTDFrameHeader.Buffer` instance allocated with `memCalloc`.
`static ZSTDFrameHeader`	`callocStack()` Returns a new `ZSTDFrameHeader` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZSTDFrameHeader.Buffer`	`callocStack(int capacity)` Returns a new `ZSTDFrameHeader.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZSTDFrameHeader.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDFrameHeader.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static ZSTDFrameHeader`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDFrameHeader` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`checksumFlag()` Returns the value of the `checksumFlag` field.
`static ZSTDFrameHeader`	`create()` Returns a new `ZSTDFrameHeader` instance allocated with `BufferUtils`.
`static ZSTDFrameHeader.Buffer`	`create(int capacity)` Returns a new `ZSTDFrameHeader.Buffer` instance allocated with `BufferUtils`.
`static ZSTDFrameHeader`	`create(long address)` Returns a new `ZSTDFrameHeader` instance for the specified memory address.
`static ZSTDFrameHeader.Buffer`	`create(long address, int capacity)` Create a `ZSTDFrameHeader.Buffer` instance at the specified memory.
`static ZSTDFrameHeader`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static ZSTDFrameHeader.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`dictID()` Returns the value of the `dictID` field.
`long`	`frameContentSize()` Returns the value of the `frameContentSize` field.
`int`	`frameType()` Returns the value of the `frameType` field.
`int`	`headerSize()` Returns the value of the `headerSize` field.
`static ZSTDFrameHeader`	`malloc()` Returns a new `ZSTDFrameHeader` instance allocated with `memAlloc`.
`static ZSTDFrameHeader.Buffer`	`malloc(int capacity)` Returns a new `ZSTDFrameHeader.Buffer` instance allocated with `memAlloc`.
`static ZSTDFrameHeader`	`mallocStack()` Returns a new `ZSTDFrameHeader` instance allocated on the thread-local `MemoryStack`.
`static ZSTDFrameHeader.Buffer`	`mallocStack(int capacity)` Returns a new `ZSTDFrameHeader.Buffer` instance allocated on the thread-local `MemoryStack`.
`static ZSTDFrameHeader.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDFrameHeader.Buffer` instance allocated on the specified `MemoryStack`.
`static ZSTDFrameHeader`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDFrameHeader` instance allocated on the specified `MemoryStack`.
`static int`	`nblockSizeMax(long struct)` Unsafe version of `blockSizeMax()`.
`static int`	`nchecksumFlag(long struct)` Unsafe version of `checksumFlag()`.
`static int`	`ndictID(long struct)` Unsafe version of `dictID()`.
`static long`	`nframeContentSize(long struct)` Unsafe version of `frameContentSize()`.
`static int`	`nframeType(long struct)` Unsafe version of `frameType()`.
`static int`	`nheaderSize(long struct)` Unsafe version of `headerSize()`.
`static long`	`nwindowSize(long struct)` Unsafe version of `windowSize()`.
`int`	`sizeof()`
`long`	`windowSize()` Returns the value of the `windowSize` field.

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.
  - FRAMECONTENTSIZE
```
public static final int FRAMECONTENTSIZE
```
    The struct member offsets.
  - WINDOWSIZE
```
public static final int WINDOWSIZE
```
    The struct member offsets.
  - BLOCKSIZEMAX
```
public static final int BLOCKSIZEMAX
```
    The struct member offsets.
  - FRAMETYPE
```
public static final int FRAMETYPE
```
    The struct member offsets.
  - HEADERSIZE
```
public static final int HEADERSIZE
```
    The struct member offsets.
  - DICTID
```
public static final int DICTID
```
    The struct member offsets.
  - CHECKSUMFLAG
```
public static final int CHECKSUMFLAG
```
    The struct member offsets.
- Constructor Detail
  - ZSTDFrameHeader
```
public ZSTDFrameHeader(java.nio.ByteBuffer container)
```
    Creates a ZSTDFrameHeader 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
  - frameContentSize
```
public long frameContentSize()
```
    Returns the value of the frameContentSize field.
  - windowSize
```
public long windowSize()
```
    Returns the value of the windowSize field.
  - blockSizeMax
```
public int blockSizeMax()
```
    Returns the value of the blockSizeMax field.
  - frameType
```
public int frameType()
```
    Returns the value of the frameType field.
  - headerSize
```
public int headerSize()
```
    Returns the value of the headerSize field.
  - dictID
```
public int dictID()
```
    Returns the value of the dictID field.
  - checksumFlag
```
public int checksumFlag()
```
    Returns the value of the checksumFlag field.
  - malloc
```
public static ZSTDFrameHeader malloc()
```
    Returns a new ZSTDFrameHeader instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static ZSTDFrameHeader calloc()
```
    Returns a new ZSTDFrameHeader instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static ZSTDFrameHeader create()
```
    Returns a new ZSTDFrameHeader instance allocated with BufferUtils.
  - create
```
public static ZSTDFrameHeader create(long address)
```
    Returns a new ZSTDFrameHeader instance for the specified memory address.
  - createSafe
```
@Nullable
public static ZSTDFrameHeader createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static ZSTDFrameHeader.Buffer malloc(int capacity)
```
    Returns a new ZSTDFrameHeader.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static ZSTDFrameHeader.Buffer calloc(int capacity)
```
    Returns a new ZSTDFrameHeader.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ZSTDFrameHeader.Buffer create(int capacity)
```
    Returns a new ZSTDFrameHeader.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ZSTDFrameHeader.Buffer create(long address,
                                            int capacity)
```
    Create a ZSTDFrameHeader.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static ZSTDFrameHeader.Buffer createSafe(long address,
                                                          int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static ZSTDFrameHeader mallocStack()
```
    Returns a new ZSTDFrameHeader instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static ZSTDFrameHeader callocStack()
```
    Returns a new ZSTDFrameHeader instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static ZSTDFrameHeader mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDFrameHeader instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static ZSTDFrameHeader callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDFrameHeader instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static ZSTDFrameHeader.Buffer mallocStack(int capacity)
```
    Returns a new ZSTDFrameHeader.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static ZSTDFrameHeader.Buffer callocStack(int capacity)
```
    Returns a new ZSTDFrameHeader.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static ZSTDFrameHeader.Buffer mallocStack(int capacity,
                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDFrameHeader.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static ZSTDFrameHeader.Buffer callocStack(int capacity,
                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDFrameHeader.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
  - nframeContentSize
```
public static long nframeContentSize(long struct)
```
    Unsafe version of frameContentSize().
  - nwindowSize
```
public static long nwindowSize(long struct)
```
    Unsafe version of windowSize().
  - nblockSizeMax
```
public static int nblockSizeMax(long struct)
```
    Unsafe version of blockSizeMax().
  - nframeType
```
public static int nframeType(long struct)
```
    Unsafe version of frameType().
  - nheaderSize
```
public static int nheaderSize(long struct)
```
    Unsafe version of headerSize().
  - ndictID
```
public static int ndictID(long struct)
```
    Unsafe version of dictID().
  - nchecksumFlag
```
public static int nchecksumFlag(long struct)
```
    Unsafe version of checksumFlag().

Class ZSTDFrameHeader

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

FRAMECONTENTSIZE

WINDOWSIZE

BLOCKSIZEMAX

FRAMETYPE

HEADERSIZE

DICTID

CHECKSUMFLAG

Constructor Detail

ZSTDFrameHeader

Method Detail

sizeof

frameContentSize

windowSize

blockSizeMax

frameType

headerSize

dictID

checksumFlag

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nframeContentSize

nwindowSize

nblockSizeMax

nframeType

nheaderSize

ndictID

nchecksumFlag