org.lwjgl.util.lz4.LZ4FPreferences

All Implemented Interfaces:: AutoCloseable, NativeResource, Pointer

public class LZ4FPreferences extends Struct<LZ4FPreferences> implements NativeResource


 struct LZ4F_preferences_t {
     {@link LZ4FFrameInfo LZ4F_frameInfo_t} frameInfo;
     int compressionLevel;
     unsigned autoFlush;
     unsigned favorDecSpeed;
     unsigned reserved[3];
 }

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

LZ4FPreferences.Buffer

An array of LZ4FPreferences structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
Field Summary

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

AUTOFLUSH

The struct member offsets.

static final int

COMPRESSIONLEVEL

The struct member offsets.

static final int

FAVORDECSPEED

The struct member offsets.

static final int

FRAMEINFO

The struct member offsets.

static final int

RESERVED

The struct member offsets.

static final 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

Description

LZ4FPreferences(ByteBuffer container)

Creates a LZ4FPreferences instance at the current position of the specified ByteBuffer container.
Method Summary

Modifier and Type

Method

Description

boolean

autoFlush()

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.Buffer

calloc(int capacity, MemoryStack stack)

Returns a new LZ4FPreferences.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

static LZ4FPreferences

calloc(MemoryStack stack)

Returns a new LZ4FPreferences instance allocated on the specified MemoryStack and initializes all its bits to zero.

static LZ4FPreferences

callocStack()

Deprecated.

static LZ4FPreferences.Buffer

callocStack(int capacity)

Deprecated.

static LZ4FPreferences.Buffer

callocStack(int capacity, MemoryStack stack)

Deprecated.

static LZ4FPreferences

callocStack(MemoryStack stack)

Deprecated.

int

compressionLevel()

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 @Nullable LZ4FPreferences

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable LZ4FPreferences.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

boolean

favorDecSpeed()

LZ4FPreferences

favorDecSpeed(boolean value)

Sets the specified value to the favorDecSpeed field.

LZ4FFrameInfo

frameInfo()

LZ4FPreferences

frameInfo(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.Buffer

malloc(int capacity, MemoryStack stack)

Returns a new LZ4FPreferences.Buffer instance allocated on the specified MemoryStack.

static LZ4FPreferences

malloc(MemoryStack stack)

Returns a new LZ4FPreferences instance allocated on the specified MemoryStack.

static LZ4FPreferences

mallocStack()

Deprecated.

static LZ4FPreferences.Buffer

mallocStack(int capacity)

Deprecated.

static LZ4FPreferences.Buffer

mallocStack(int capacity, MemoryStack stack)

Deprecated.

static LZ4FPreferences

mallocStack(MemoryStack stack)

Deprecated.

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 IntBuffer

nreserved(long struct)

Unsafe version of reserved().

static int

nreserved(long struct, int index)

Unsafe version of reserved.

static void

nreserved(long struct, int index, int value)

Unsafe version of reserved.

static void

nreserved(long struct, IntBuffer value)

Unsafe version of reserved.

IntBuffer

reserved()

int

reserved(int index)

LZ4FPreferences

reserved(int index, int value)

Sets the specified value at the specified index of the reserved field.

LZ4FPreferences

reserved(IntBuffer value)

Copies the specified IntBuffer to the reserved field.

LZ4FPreferences

set(LZ4FFrameInfo frameInfo, int compressionLevel, boolean autoFlush, boolean favorDecSpeed, IntBuffer reserved)

Initializes this struct with the specified values.

LZ4FPreferences

set(LZ4FPreferences src)

Copies the specified struct data to this struct.

int

sizeof()

Returns sizeof(struct).

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validate

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 Details
- 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 Details
- LZ4FPreferences
  
  public LZ4FPreferences(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 Details
- sizeof
  
  public int sizeof()
  
  Description copied from class: Struct
  
  Returns sizeof(struct).
  
  Specified by:
  
  sizeof in class Struct<LZ4FPreferences>
- 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 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(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(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, 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
  
  public static @Nullable 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
  
  public static @Nullable LZ4FPreferences.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- mallocStack
  
  @Deprecated public static LZ4FPreferences mallocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static LZ4FPreferences callocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static LZ4FPreferences mallocStack(MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static LZ4FPreferences callocStack(MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static LZ4FPreferences.Buffer mallocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static LZ4FPreferences.Buffer callocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- mallocStack
  
  @Deprecated public static LZ4FPreferences.Buffer mallocStack(int capacity, MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static LZ4FPreferences.Buffer callocStack(int capacity, MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- malloc
  
  public static LZ4FPreferences malloc(MemoryStack stack)
  
  Returns a new LZ4FPreferences instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static LZ4FPreferences calloc(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
- malloc
  
  public static LZ4FPreferences.Buffer malloc(int capacity, MemoryStack stack)
  
  Returns a new LZ4FPreferences.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static LZ4FPreferences.Buffer calloc(int capacity, MemoryStack stack)
  
  Returns a new LZ4FPreferences.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- 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 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, IntBuffer value)
  
  Unsafe version of reserved.
- nreserved
  
  public static void nreserved(long struct, int index, int value)
  
  Unsafe version of reserved.

Class LZ4FPreferences

Nested Class Summary

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

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 Details

SIZEOF

ALIGNOF

FRAMEINFO

COMPRESSIONLEVEL

AUTOFLUSH

FAVORDECSPEED

RESERVED

Constructor Details

LZ4FPreferences

Method Details

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

malloc

calloc

malloc

calloc

nframeInfo

ncompressionLevel

nautoFlush

nfavorDecSpeed

nreserved

nreserved

nframeInfo

ncompressionLevel

nautoFlush

nfavorDecSpeed

nreserved

nreserved