Top Description Inners Fields Constructors Methods
org.lwjgl.util.lz4

public Class LZ4FDecompressOptions

extends Struct<LZ4FDecompressOptions>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct LZ4F_decompressOptions_t
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


struct LZ4F_decompressOptions_t {
    unsigned stableDst;
    unsigned skipChecksums;
    unsigned reserved1;
    unsigned reserved0;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
LZ4FDecompressOptions.Buffer

An array of LZ4FDecompressOptions structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
RESERVED0

The struct member offsets.

public static final int
RESERVED1

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SKIPCHECKSUMS

The struct member offsets.

public static final int
STABLEDST

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
LZ4FDecompressOptions(long address, ByteBuffer container)

public
LZ4FDecompressOptions(ByteBuffer container)

Creates a LZ4FDecompressOptions instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static LZ4FDecompressOptions
calloc()

Returns a new LZ4FDecompressOptions instance allocated with memCalloc.

public static LZ4FDecompressOptions.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new LZ4FDecompressOptions.Buffer instance allocated with memCalloc.

public static LZ4FDecompressOptions
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static LZ4FDecompressOptions.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static LZ4FDecompressOptions
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static LZ4FDecompressOptions
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static LZ4FDecompressOptions.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static LZ4FDecompressOptions.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected LZ4FDecompressOptions
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static LZ4FDecompressOptions
create()

Returns a new LZ4FDecompressOptions instance allocated with BufferUtils.

public static LZ4FDecompressOptions
create(long address)

Returns a new LZ4FDecompressOptions instance for the specified memory address.

public static LZ4FDecompressOptions.Buffer
create(int
the buffer capacity
capacity)

Returns a new LZ4FDecompressOptions.Buffer instance allocated with BufferUtils.

public static LZ4FDecompressOptions.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a LZ4FDecompressOptions.Buffer instance at the specified memory.

public static LZ4FDecompressOptions
createSafe(long address)

Like create, but returns null if address is NULL.

public static LZ4FDecompressOptions.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static LZ4FDecompressOptions
malloc()

Returns a new LZ4FDecompressOptions instance allocated with memAlloc.

public static LZ4FDecompressOptions.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new LZ4FDecompressOptions.Buffer instance allocated with memAlloc.

public static LZ4FDecompressOptions
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new LZ4FDecompressOptions instance allocated on the specified MemoryStack.

public static LZ4FDecompressOptions.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static LZ4FDecompressOptions
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static LZ4FDecompressOptions
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static LZ4FDecompressOptions.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static LZ4FDecompressOptions.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nreserved0(long struct)

Unsafe version of reserved0.

public static void
nreserved0(long struct, int value)

Unsafe version of reserved0.

public static int
nreserved1(long struct)

Unsafe version of reserved1.

public static void
nreserved1(long struct, int value)

Unsafe version of reserved1.

public static int
nskipChecksums(long struct)

Unsafe version of skipChecksums.

public static void
nskipChecksums(long struct, int value)

Unsafe version of skipChecksums.

public static int
nstableDst(long struct)

Unsafe version of stableDst.

public static void
nstableDst(long struct, int value)

Unsafe version of stableDst.

public int
reserved0()

idem

public LZ4FDecompressOptions
reserved0(int value)

Sets the specified value to the reserved0 field.

public int
reserved1()

must be set to zero for forward compatibility

public LZ4FDecompressOptions
reserved1(int value)

Sets the specified value to the reserved1 field.

public LZ4FDecompressOptions
set(int stableDst, int skipChecksums, int reserved1, int reserved0)

Initializes this struct with the specified values.

public LZ4FDecompressOptions

Returns:

this struct
set(LZ4FDecompressOptions
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
skipChecksums()

disable checksum calculation and verification, even when one is present in frame, to save CPU time.

public LZ4FDecompressOptions
skipChecksums(int value)

Sets the specified value to the skipChecksums field.

public int
stableDst()

pledges that last 64KB decompressed data will remain available unmodified between invocations.

public LZ4FDecompressOptions
stableDst(int value)

Sets the specified value to the stableDst field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

RESERVED0back to summary
public static final int RESERVED0

The struct member offsets.

RESERVED1back to summary
public static final int RESERVED1

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SKIPCHECKSUMSback to summary
public static final int SKIPCHECKSUMS

The struct member offsets.

STABLEDSTback to summary
public static final int STABLEDST

The struct member offsets.

Constructor Detail

LZ4FDecompressOptionsback to summary
protected LZ4FDecompressOptions(long address, ByteBuffer container)
LZ4FDecompressOptionsback to summary
public LZ4FDecompressOptions(ByteBuffer container)

Creates a LZ4FDecompressOptions 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

callocback to summary
public static LZ4FDecompressOptions calloc()

Returns a new LZ4FDecompressOptions instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static LZ4FDecompressOptions.Buffer calloc(int capacity)

Returns a new LZ4FDecompressOptions.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static LZ4FDecompressOptions calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static LZ4FDecompressOptions.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static LZ4FDecompressOptions callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static LZ4FDecompressOptions callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static LZ4FDecompressOptions.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static LZ4FDecompressOptions.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected LZ4FDecompressOptions create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static LZ4FDecompressOptions create()

Returns a new LZ4FDecompressOptions instance allocated with BufferUtils.

createback to summary
public static LZ4FDecompressOptions create(long address)

Returns a new LZ4FDecompressOptions instance for the specified memory address.

createback to summary
public static LZ4FDecompressOptions.Buffer create(int capacity)

Returns a new LZ4FDecompressOptions.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static LZ4FDecompressOptions.Buffer create(long address, int capacity)

Create a LZ4FDecompressOptions.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static LZ4FDecompressOptions createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static LZ4FDecompressOptions.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static LZ4FDecompressOptions malloc()

Returns a new LZ4FDecompressOptions instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static LZ4FDecompressOptions.Buffer malloc(int capacity)

Returns a new LZ4FDecompressOptions.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static LZ4FDecompressOptions malloc(MemoryStack stack)

Returns a new LZ4FDecompressOptions instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static LZ4FDecompressOptions.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static LZ4FDecompressOptions mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static LZ4FDecompressOptions mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static LZ4FDecompressOptions.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static LZ4FDecompressOptions.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nreserved0back to summary
public static int nreserved0(long struct)

Unsafe version of reserved0.

nreserved0back to summary
public static void nreserved0(long struct, int value)

Unsafe version of reserved0.

nreserved1back to summary
public static int nreserved1(long struct)

Unsafe version of reserved1.

nreserved1back to summary
public static void nreserved1(long struct, int value)

Unsafe version of reserved1.

nskipChecksumsback to summary
public static int nskipChecksums(long struct)

Unsafe version of skipChecksums.

nskipChecksumsback to summary
public static void nskipChecksums(long struct, int value)

Unsafe version of skipChecksums.

nstableDstback to summary
public static int nstableDst(long struct)

Unsafe version of stableDst.

nstableDstback to summary
public static void nstableDst(long struct, int value)

Unsafe version of stableDst.

reserved0back to summary
public int reserved0()

idem

Annotations
@NativeType:unsigned
reserved0back to summary
public LZ4FDecompressOptions reserved0(int value)

Sets the specified value to the reserved0 field.

reserved1back to summary
public int reserved1()

must be set to zero for forward compatibility

Annotations
@NativeType:unsigned
reserved1back to summary
public LZ4FDecompressOptions reserved1(int value)

Sets the specified value to the reserved1 field.

setback to summary
public LZ4FDecompressOptions set(int stableDst, int skipChecksums, int reserved1, int reserved0)

Initializes this struct with the specified values.

setback to summary
public LZ4FDecompressOptions set(LZ4FDecompressOptions src)

Copies the specified struct data to this struct.

Parameters
src:LZ4FDecompressOptions

the source struct

Returns:LZ4FDecompressOptions

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
skipChecksumsback to summary
public int skipChecksums()

disable checksum calculation and verification, even when one is present in frame, to save CPU time.

Setting this option to 1 once disables all checksums for the rest of the frame.

Annotations
@NativeType:unsigned
skipChecksumsback to summary
public LZ4FDecompressOptions skipChecksums(int value)

Sets the specified value to the skipChecksums field.

stableDstback to summary
public int stableDst()

pledges that last 64KB decompressed data will remain available unmodified between invocations.

This optimization skips storage operations in tmp buffers.

Annotations
@NativeType:unsigned
stableDstback to summary
public LZ4FDecompressOptions stableDst(int value)

Sets the specified value to the stableDst field.

org.lwjgl.util.lz4 back to summary

public Class LZ4FDecompressOptions.Buffer

extends StructBuffer<LZ4FDecompressOptions, LZ4FDecompressOptions.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of LZ4FDecompressOptions structs.

Field Summary

Modifier and TypeField and Description
private static final LZ4FDecompressOptions
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new LZ4FDecompressOptions.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected LZ4FDecompressOptions
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public int

Returns:

the value of the LZ4FDecompressOptions#reserved0 field.
reserved0()

public LZ4FDecompressOptions.Buffer
reserved0(int value)

Sets the specified value to the LZ4FDecompressOptions#reserved0 field.

public int

Returns:

the value of the LZ4FDecompressOptions#reserved1 field.
reserved1()

public LZ4FDecompressOptions.Buffer
reserved1(int value)

Sets the specified value to the LZ4FDecompressOptions#reserved1 field.

protected LZ4FDecompressOptions.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the LZ4FDecompressOptions#skipChecksums field.
skipChecksums()

public LZ4FDecompressOptions.Buffer
skipChecksums(int value)

Sets the specified value to the LZ4FDecompressOptions#skipChecksums field.

public int

Returns:

the value of the LZ4FDecompressOptions#stableDst field.
stableDst()

public LZ4FDecompressOptions.Buffer
stableDst(int value)

Sets the specified value to the LZ4FDecompressOptions#stableDst field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final LZ4FDecompressOptions ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new LZ4FDecompressOptions.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by LZ4FDecompressOptions#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected LZ4FDecompressOptions getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
reserved0back to summary
public int reserved0()
Returns:int

the value of the LZ4FDecompressOptions#reserved0 field.

Annotations
@NativeType:unsigned
reserved0back to summary
public LZ4FDecompressOptions.Buffer reserved0(int value)

Sets the specified value to the LZ4FDecompressOptions#reserved0 field.

reserved1back to summary
public int reserved1()
Returns:int

the value of the LZ4FDecompressOptions#reserved1 field.

Annotations
@NativeType:unsigned
reserved1back to summary
public LZ4FDecompressOptions.Buffer reserved1(int value)

Sets the specified value to the LZ4FDecompressOptions#reserved1 field.

selfback to summary
protected LZ4FDecompressOptions.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
skipChecksumsback to summary
public int skipChecksums()
Returns:int

the value of the LZ4FDecompressOptions#skipChecksums field.

Annotations
@NativeType:unsigned
skipChecksumsback to summary
public LZ4FDecompressOptions.Buffer skipChecksums(int value)

Sets the specified value to the LZ4FDecompressOptions#skipChecksums field.

stableDstback to summary
public int stableDst()
Returns:int

the value of the LZ4FDecompressOptions#stableDst field.

Annotations
@NativeType:unsigned
stableDstback to summary
public LZ4FDecompressOptions.Buffer stableDst(int value)

Sets the specified value to the LZ4FDecompressOptions#stableDst field.