LZ4FPreferences (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class LZ4FPreferences
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Makes it possible to supply advanced compression instructions to streaming interface. Structure must be first init to 0, using memset(), setting all parameters to default. All reserved fields must be set to zero.
Member documentation
- compressionLevel – 0: default (fast mode); values > CLEVEL_MAX count as CLEVEL_MAX; values > 0 trigger "fast acceleration"
- autoFlush – 1: always flush, reduces usage of internal buffers
- favorDecSpeed – 1: parser favors decompression speed vs compression ratio. Only works for high compression modes (≥ CLEVEL_OPT_MIN). Since version 1.8.2.
- reserved[3] – must be zero for forward compatibility
Layout
```
 struct LZ4F_preferences_t {
     LZ4F_frameInfo_t frameInfo;
     int compressionLevel;
     unsigned autoFlush;
     unsigned favorDecSpeed;
     unsigned reserved[3];
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

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

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

Constructors
Constructor and Description
`LZ4FPreferences(java.nio.ByteBuffer container)` Creates a `LZ4FPreferences` 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
`boolean`	`autoFlush()` Returns the value of the `autoFlush` field.
`LZ4FPreferences`	`autoFlush(boolean value)` Sets the specified value to the `autoFlush` field.
`static LZ4FPreferences`	`calloc()` Returns a new `LZ4FPreferences` instance allocated with `memCalloc`.
`static LZ4FPreferences.Buffer`	`calloc(int capacity)` Returns a new `LZ4FPreferences.Buffer` instance allocated with `memCalloc`.
`static LZ4FPreferences`	`callocStack()` Returns a new `LZ4FPreferences` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static LZ4FPreferences.Buffer`	`callocStack(int capacity)` Returns a new `LZ4FPreferences.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static LZ4FPreferences.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `LZ4FPreferences.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static LZ4FPreferences`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `LZ4FPreferences` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`compressionLevel()` Returns the value of the `compressionLevel` field.
`LZ4FPreferences`	`compressionLevel(int value)` Sets the specified value to the `compressionLevel` field.
`static LZ4FPreferences`	`create()` Returns a new `LZ4FPreferences` instance allocated with `BufferUtils`.
`static LZ4FPreferences.Buffer`	`create(int capacity)` Returns a new `LZ4FPreferences.Buffer` instance allocated with `BufferUtils`.
`static LZ4FPreferences`	`create(long address)` Returns a new `LZ4FPreferences` instance for the specified memory address.
`static LZ4FPreferences.Buffer`	`create(long address, int capacity)` Create a `LZ4FPreferences.Buffer` instance at the specified memory.
`static LZ4FPreferences`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static LZ4FPreferences.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`boolean`	`favorDecSpeed()` Returns the value of the `favorDecSpeed` field.
`LZ4FPreferences`	`favorDecSpeed(boolean value)` Sets the specified value to the `favorDecSpeed` field.
`LZ4FFrameInfo`	`frameInfo()` Returns a `LZ4FFrameInfo` view of the `frameInfo` field.
`LZ4FPreferences`	`frameInfo(java.util.function.Consumer<LZ4FFrameInfo> consumer)` Passes the `frameInfo` field to the specified `Consumer`.
`LZ4FPreferences`	`frameInfo(LZ4FFrameInfo value)` Copies the specified `LZ4FFrameInfo` to the `frameInfo` field.
`static LZ4FPreferences`	`malloc()` Returns a new `LZ4FPreferences` instance allocated with `memAlloc`.
`static LZ4FPreferences.Buffer`	`malloc(int capacity)` Returns a new `LZ4FPreferences.Buffer` instance allocated with `memAlloc`.
`static LZ4FPreferences`	`mallocStack()` Returns a new `LZ4FPreferences` instance allocated on the thread-local `MemoryStack`.
`static LZ4FPreferences.Buffer`	`mallocStack(int capacity)` Returns a new `LZ4FPreferences.Buffer` instance allocated on the thread-local `MemoryStack`.
`static LZ4FPreferences.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `LZ4FPreferences.Buffer` instance allocated on the specified `MemoryStack`.
`static LZ4FPreferences`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `LZ4FPreferences` instance allocated on the specified `MemoryStack`.
`static int`	`nautoFlush(long struct)` Unsafe version of `autoFlush()`.
`static void`	`nautoFlush(long struct, int value)` Unsafe version of `autoFlush`.
`static int`	`ncompressionLevel(long struct)` Unsafe version of `compressionLevel()`.
`static void`	`ncompressionLevel(long struct, int value)` Unsafe version of `compressionLevel`.
`static int`	`nfavorDecSpeed(long struct)` Unsafe version of `favorDecSpeed()`.
`static void`	`nfavorDecSpeed(long struct, int value)` Unsafe version of `favorDecSpeed`.
`static LZ4FFrameInfo`	`nframeInfo(long struct)` Unsafe version of `frameInfo()`.
`static void`	`nframeInfo(long struct, LZ4FFrameInfo value)` Unsafe version of `frameInfo`.
`static java.nio.IntBuffer`	`nreserved(long struct)` Unsafe version of `reserved()`.
`static int`	`nreserved(long struct, int index)` Unsafe version of `reserved`.
`static void`	`nreserved(long struct, java.nio.IntBuffer value)` Unsafe version of `reserved`.
`static void`	`nreserved(long struct, int index, int value)` Unsafe version of `reserved`.
`java.nio.IntBuffer`	`reserved()` Returns a `IntBuffer` view of the `reserved` field.
`int`	`reserved(int index)` Returns the value at the specified index of the `reserved` field.
`LZ4FPreferences`	`reserved(java.nio.IntBuffer value)` Copies the specified `IntBuffer` to the `reserved` field.
`LZ4FPreferences`	`reserved(int index, int value)` Sets the specified value at the specified index of the `reserved` field.
`LZ4FPreferences`	`set(LZ4FFrameInfo frameInfo, int compressionLevel, boolean autoFlush, boolean favorDecSpeed, java.nio.IntBuffer reserved)` Initializes this struct with the specified values.
`LZ4FPreferences`	`set(LZ4FPreferences 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.
  - FRAMEINFO
```
public static final int FRAMEINFO
```
    The struct member offsets.
  - COMPRESSIONLEVEL
```
public static final int COMPRESSIONLEVEL
```
    The struct member offsets.
  - AUTOFLUSH
```
public static final int AUTOFLUSH
```
    The struct member offsets.
  - FAVORDECSPEED
```
public static final int FAVORDECSPEED
```
    The struct member offsets.
  - RESERVED
```
public static final int RESERVED
```
    The struct member offsets.
- Constructor Detail
  - LZ4FPreferences
```
public LZ4FPreferences(java.nio.ByteBuffer container)
```
    Creates a LZ4FPreferences 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
  - frameInfo
```
public LZ4FFrameInfo frameInfo()
```
    Returns a LZ4FFrameInfo view of the frameInfo field.
  - compressionLevel
```
public int compressionLevel()
```
    Returns the value of the compressionLevel field.
  - autoFlush
```
public boolean autoFlush()
```
    Returns the value of the autoFlush field.
  - favorDecSpeed
```
public boolean favorDecSpeed()
```
    Returns the value of the favorDecSpeed field.
  - reserved
```
public java.nio.IntBuffer reserved()
```
    Returns a IntBuffer view of the reserved field.
  - reserved
```
public int reserved(int index)
```
    Returns the value at the specified index of the reserved field.
  - frameInfo
```
public LZ4FPreferences frameInfo(LZ4FFrameInfo value)
```
    Copies the specified LZ4FFrameInfo to the frameInfo field.
  - frameInfo
```
public LZ4FPreferences frameInfo(java.util.function.Consumer<LZ4FFrameInfo> consumer)
```
    Passes the frameInfo field to the specified Consumer.
  - compressionLevel
```
public LZ4FPreferences compressionLevel(int value)
```
    Sets the specified value to the compressionLevel field.
  - autoFlush
```
public LZ4FPreferences autoFlush(boolean value)
```
    Sets the specified value to the autoFlush field.
  - favorDecSpeed
```
public LZ4FPreferences favorDecSpeed(boolean value)
```
    Sets the specified value to the favorDecSpeed field.
  - reserved
```
public LZ4FPreferences reserved(java.nio.IntBuffer value)
```
    Copies the specified IntBuffer to the reserved field.
  - reserved
```
public LZ4FPreferences reserved(int index,
                                int value)
```
    Sets the specified value at the specified index of the reserved field.
  - set
```
public LZ4FPreferences set(LZ4FFrameInfo frameInfo,
                           int compressionLevel,
                           boolean autoFlush,
                           boolean favorDecSpeed,
                           java.nio.IntBuffer reserved)
```
    Initializes this struct with the specified values.
  - set
```
public LZ4FPreferences set(LZ4FPreferences src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static LZ4FPreferences malloc()
```
    Returns a new LZ4FPreferences instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static LZ4FPreferences calloc()
```
    Returns a new LZ4FPreferences instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static LZ4FPreferences create()
```
    Returns a new LZ4FPreferences instance allocated with BufferUtils.
  - create
```
public static LZ4FPreferences create(long address)
```
    Returns a new LZ4FPreferences instance for the specified memory address.
  - createSafe
```
@Nullable
public static LZ4FPreferences createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static LZ4FPreferences.Buffer malloc(int capacity)
```
    Returns a new LZ4FPreferences.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static LZ4FPreferences.Buffer calloc(int capacity)
```
    Returns a new LZ4FPreferences.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static LZ4FPreferences.Buffer create(int capacity)
```
    Returns a new LZ4FPreferences.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static LZ4FPreferences.Buffer create(long address,
                                            int capacity)
```
    Create a LZ4FPreferences.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static LZ4FPreferences.Buffer createSafe(long address,
                                                          int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static LZ4FPreferences mallocStack()
```
    Returns a new LZ4FPreferences instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static LZ4FPreferences callocStack()
```
    Returns a new LZ4FPreferences instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static LZ4FPreferences mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new LZ4FPreferences instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static LZ4FPreferences callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new LZ4FPreferences instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static LZ4FPreferences.Buffer mallocStack(int capacity)
```
    Returns a new LZ4FPreferences.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static LZ4FPreferences.Buffer callocStack(int capacity)
```
    Returns a new LZ4FPreferences.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static LZ4FPreferences.Buffer mallocStack(int capacity,
                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new LZ4FPreferences.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static LZ4FPreferences.Buffer callocStack(int capacity,
                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new LZ4FPreferences.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
  - nframeInfo
```
public static LZ4FFrameInfo nframeInfo(long struct)
```
    Unsafe version of frameInfo().
  - ncompressionLevel
```
public static int ncompressionLevel(long struct)
```
    Unsafe version of compressionLevel().
  - nautoFlush
```
public static int nautoFlush(long struct)
```
    Unsafe version of autoFlush().
  - nfavorDecSpeed
```
public static int nfavorDecSpeed(long struct)
```
    Unsafe version of favorDecSpeed().
  - nreserved
```
public static java.nio.IntBuffer nreserved(long struct)
```
    Unsafe version of reserved().
  - nreserved
```
public static int nreserved(long struct,
                            int index)
```
    Unsafe version of reserved.
  - nframeInfo
```
public static void nframeInfo(long struct,
                              LZ4FFrameInfo value)
```
    Unsafe version of frameInfo.
  - ncompressionLevel
```
public static void ncompressionLevel(long struct,
                                     int value)
```
    Unsafe version of compressionLevel.
  - nautoFlush
```
public static void nautoFlush(long struct,
                              int value)
```
    Unsafe version of autoFlush.
  - nfavorDecSpeed
```
public static void nfavorDecSpeed(long struct,
                                  int value)
```
    Unsafe version of favorDecSpeed.
  - nreserved
```
public static void nreserved(long struct,
                             java.nio.IntBuffer value)
```
    Unsafe version of reserved.
  - nreserved
```
public static void nreserved(long struct,
                             int index,
                             int value)
```
    Unsafe version of reserved.

Class LZ4FPreferences

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

FRAMEINFO

COMPRESSIONLEVEL

AUTOFLUSH

FAVORDECSPEED

RESERVED

Constructor Detail

LZ4FPreferences

Method Detail

sizeof

frameInfo

compressionLevel

autoFlush

favorDecSpeed

reserved

reserved

frameInfo

frameInfo

compressionLevel

autoFlush

favorDecSpeed

reserved

reserved

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nframeInfo

ncompressionLevel

nautoFlush

nfavorDecSpeed

nreserved

nreserved

nframeInfo

ncompressionLevel

nautoFlush

nfavorDecSpeed

nreserved

nreserved