LZ4FFrameInfo (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.util.lz4.LZ4FFrameInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class LZ4FFrameInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Makes it possible to set or read frame parameters.
Structure must be first init to 0, using memset(), setting all parameters to default. It's then possible to update selectively some parameter.

Member documentation
- blockSizeID – 0 == default. One of:
  max64KB max256KB max1MB max4MB
- blockMode – 0 == default. One of:
  blockLinked blockIndependent blockChecksumEnabled
- contentChecksumFlag – 1: frame terminated with 32-bit checksum of decompressed data; 0: disabled (default)
- frameType – read-only field. One of:
  frame skippableFrame
- contentSize – size of uncompressed content ; 0 == unknown
- dictID – dictionary ID, sent by compressor to help decoder select correct dictionary; 0 == no dictID provided
- blockChecksumFlag – 1: each block followed by a checksum of block's compressed data; 0: disabled (default)
Layout
```
 struct LZ4F_frameInfo_t {
     LZ4F_blockSizeID_t blockSizeID;
     LZ4F_blockMode_t blockMode;
     LZ4F_contentChecksum_t contentChecksumFlag;
     LZ4F_frameType_t frameType;
     unsigned long long contentSize;
     unsigned dictID;
     LZ4F_blockChecksum_t blockChecksumFlag;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`BLOCKCHECKSUMFLAG` The struct member offsets.
`static int`	`BLOCKMODE` The struct member offsets.
`static int`	`BLOCKSIZEID` The struct member offsets.
`static int`	`CONTENTCHECKSUMFLAG` The struct member offsets.
`static int`	`CONTENTSIZE` The struct member offsets.
`static int`	`DICTID` The struct member offsets.
`static int`	`FRAMETYPE` 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

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

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

Class LZ4FFrameInfo

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

BLOCKSIZEID

BLOCKMODE

CONTENTCHECKSUMFLAG

FRAMETYPE

CONTENTSIZE

DICTID

BLOCKCHECKSUMFLAG

Constructor Detail

LZ4FFrameInfo

Method Detail

sizeof

blockSizeID

blockMode

contentChecksumFlag

frameType

contentSize

dictID

blockChecksumFlag

blockSizeID

blockMode

contentChecksumFlag

frameType

contentSize

dictID

blockChecksumFlag

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nblockSizeID

nblockMode

ncontentChecksumFlag

nframeType

ncontentSize

ndictID

nblockChecksumFlag

nblockSizeID

nblockMode

ncontentChecksumFlag

nframeType

ncontentSize

ndictID

nblockChecksumFlag