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

public Class LZ4StreamDecode

extends Struct<LZ4StreamDecode>
Class Inheritance
Annotations
@NativeType:union LZ4_streamDecode_t
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*

Layout


union LZ4_streamDecode_t {
    char minStateSize[LZ4_STREAMDECODE_MINSIZE];
    LZ4_streamDecode_t_internal internal_donotuse;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
INTERNAL_DONOTUSE

The struct member offsets.

public static final int
MINSTATESIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
LZ4StreamDecode(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
protected LZ4StreamDecode
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 LZ4StreamDecode
create(long address)

Returns a new LZ4StreamDecode instance for the specified memory address.

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

Create a LZ4StreamDecode.Buffer instance at the specified memory.

public static LZ4StreamDecode
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public LZ4StreamDecodeInternal

Returns:

a LZ4StreamDecodeInternal view of the internal_donotuse field.
internal_donotuse
()

public ByteBuffer

Returns:

a ByteBuffer view of the minStateSize field.
minStateSize
()

public byte

Returns:

the value at the specified index of the minStateSize field.
minStateSize
(int index)

public static LZ4StreamDecodeInternal
ninternal_donotuse(long struct)

Unsafe version of internal_donotuse.

public static ByteBuffer
nminStateSize(long struct)

Unsafe version of minStateSize.

public static byte
nminStateSize(long struct, int index)

Unsafe version of minStateSize.

public int
sizeof()

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

Returns sizeof(struct).
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.

INTERNAL_DONOTUSEback to summary
public static final int INTERNAL_DONOTUSE

The struct member offsets.

MINSTATESIZEback to summary
public static final int MINSTATESIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

LZ4StreamDecodeback to summary
protected LZ4StreamDecode(long address, ByteBuffer container)
LZ4StreamDecodeback to summary
public LZ4StreamDecode(ByteBuffer container)

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

createback to summary
protected LZ4StreamDecode 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 LZ4StreamDecode create(long address)

Returns a new LZ4StreamDecode instance for the specified memory address.

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

Create a LZ4StreamDecode.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static LZ4StreamDecode createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
internal_donotuseback to summary
public LZ4StreamDecodeInternal internal_donotuse()
Returns:LZ4StreamDecodeInternal

a LZ4StreamDecodeInternal view of the internal_donotuse field.

Annotations
@NativeType:LZ4_streamDecode_t_internal
minStateSizeback to summary
public ByteBuffer minStateSize()
Returns:ByteBuffer

a ByteBuffer view of the minStateSize field.

Annotations
@NativeType:char[LZ4_STREAMDECODE_MINSIZE]
minStateSizeback to summary
public byte minStateSize(int index)
Returns:byte

the value at the specified index of the minStateSize field.

Annotations
@NativeType:char
ninternal_donotuseback to summary
public static LZ4StreamDecodeInternal ninternal_donotuse(long struct)

Unsafe version of internal_donotuse.

nminStateSizeback to summary
public static ByteBuffer nminStateSize(long struct)

Unsafe version of minStateSize.

nminStateSizeback to summary
public static byte nminStateSize(long struct, int index)

Unsafe version of minStateSize.

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
org.lwjgl.util.lz4 back to summary

public Class LZ4StreamDecode.Buffer

extends StructBuffer<LZ4StreamDecode, LZ4StreamDecode.Buffer>
Class Inheritance

An array of LZ4StreamDecode structs.

Field Summary

Modifier and TypeField and Description
private static final LZ4StreamDecode

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new LZ4StreamDecode.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 LZ4StreamDecode
public LZ4StreamDecodeInternal

Returns:

a LZ4StreamDecodeInternal view of the internal_donotuse field.
internal_donotuse
()

public ByteBuffer

Returns:

a ByteBuffer view of the minStateSize field.
minStateSize
()

public byte

Returns:

the value at the specified index of the minStateSize field.
minStateSize
(int index)

protected LZ4StreamDecode.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final LZ4StreamDecode ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new LZ4StreamDecode.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 LZ4StreamDecode#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 LZ4StreamDecode getElementFactory()

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

Annotations
@Override
internal_donotuseback to summary
public LZ4StreamDecodeInternal internal_donotuse()
Returns:LZ4StreamDecodeInternal

a LZ4StreamDecodeInternal view of the internal_donotuse field.

Annotations
@NativeType:LZ4_streamDecode_t_internal
minStateSizeback to summary
public ByteBuffer minStateSize()
Returns:ByteBuffer

a ByteBuffer view of the minStateSize field.

Annotations
@NativeType:char[LZ4_STREAMDECODE_MINSIZE]
minStateSizeback to summary
public byte minStateSize(int index)
Returns:byte

the value at the specified index of the minStateSize field.

Annotations
@NativeType:char
selfback to summary
protected LZ4StreamDecode.Buffer self()

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

Annotations
@Override