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

public Class LZ4HCCCtxInternal

extends Struct<LZ4HCCCtxInternal>
Class Inheritance
Annotations
@NativeType:struct LZ4HC_CCtx_internal
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*

Layout


struct LZ4HC_CCtx_internal {
    LZ4_u32 hashTable[LZ4HC_HASHTABLESIZE];
    LZ4_u16 chainTable[LZ4HC_MAXD];
    LZ4_byte const * end;
    LZ4_byte const * prefixStart;
    LZ4_byte const * dictStart;
    LZ4_u32 dictLimit;
    LZ4_u32 lowLimit;
    LZ4_u32 nextToUpdate;
    short compressionLevel;
    LZ4_i8 favorDecSpeed;
    LZ4_i8 dirty;
    LZ4HC_CCtx_internal * const dictCtx;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
LZ4HCCCtxInternal.Buffer

An array of LZ4HCCCtxInternal structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CHAINTABLE

The struct member offsets.

public static final int
COMPRESSIONLEVEL

The struct member offsets.

public static final int
DICTCTX

The struct member offsets.

public static final int
DICTLIMIT

The struct member offsets.

public static final int
DICTSTART

The struct member offsets.

public static final int
DIRTY

The struct member offsets.

public static final int
END

The struct member offsets.

public static final int
FAVORDECSPEED

The struct member offsets.

public static final int
HASHTABLE

The struct member offsets.

public static final int
LOWLIMIT

The struct member offsets.

public static final int
NEXTTOUPDATE

The struct member offsets.

public static final int
PREFIXSTART

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
LZ4HCCCtxInternal(long address, ByteBuffer container)

public
LZ4HCCCtxInternal(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public ShortBuffer

Returns:

a ShortBuffer view of the chainTable field.
chainTable()

public short

Returns:

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

public short

Returns:

the value of the compressionLevel field.
compressionLevel()

protected LZ4HCCCtxInternal
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 LZ4HCCCtxInternal
create(long address)

Returns a new LZ4HCCCtxInternal instance for the specified memory address.

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

Create a LZ4HCCCtxInternal.Buffer instance at the specified memory.

public static LZ4HCCCtxInternal
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public LZ4HCCCtxInternal

Returns:

a LZ4HCCCtxInternal view of the struct pointed to by the dictCtx field.
dictCtx()

public int
dictLimit()

below that point, need extDict

public ByteBuffer

Returns:

alternate reference for extDict
dictStart(int
the number of elements in the returned buffer
capacity)

public byte
dirty()

stream has to be fully reset if this flag is set

public ByteBuffer

Returns:

next block here to continue on current prefix
end(int
the number of elements in the returned buffer
capacity)

public byte
favorDecSpeed()

favor decompression speed if this flag set, otherwise, favor compression ratio

public IntBuffer

Returns:

a IntBuffer view of the hashTable field.
hashTable()

public int

Returns:

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

public int
lowLimit()

below that point, no more dict

public static ShortBuffer
nchainTable(long struct)

Unsafe version of chainTable.

public static short
nchainTable(long struct, int index)

Unsafe version of chainTable.

public static short
ncompressionLevel(long struct)

Unsafe version of compressionLevel.

public static LZ4HCCCtxInternal
ndictCtx(long struct)

Unsafe version of dictCtx.

public static int
ndictLimit(long struct)

Unsafe version of dictLimit.

public static ByteBuffer
ndictStart(long struct, int capacity)

Unsafe version of dictStart.

public static byte
ndirty(long struct)

Unsafe version of dirty.

public static ByteBuffer
nend(long struct, int capacity)

Unsafe version of end.

public int
nextToUpdate()

index from which to continue dictionary update

public static byte
nfavorDecSpeed(long struct)

Unsafe version of favorDecSpeed.

public static IntBuffer
nhashTable(long struct)

Unsafe version of hashTable.

public static int
nhashTable(long struct, int index)

Unsafe version of hashTable.

public static int
nlowLimit(long struct)

Unsafe version of lowLimit.

public static int
nnextToUpdate(long struct)

Unsafe version of nextToUpdate.

public static ByteBuffer
nprefixStart(long struct, int capacity)

Unsafe version of prefixStart.

public ByteBuffer

Returns:

Indexes relative to this position
prefixStart(int
the number of elements in the returned buffer
capacity)

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.

CHAINTABLEback to summary
public static final int CHAINTABLE

The struct member offsets.

COMPRESSIONLEVELback to summary
public static final int COMPRESSIONLEVEL

The struct member offsets.

DICTCTXback to summary
public static final int DICTCTX

The struct member offsets.

DICTLIMITback to summary
public static final int DICTLIMIT

The struct member offsets.

DICTSTARTback to summary
public static final int DICTSTART

The struct member offsets.

DIRTYback to summary
public static final int DIRTY

The struct member offsets.

ENDback to summary
public static final int END

The struct member offsets.

FAVORDECSPEEDback to summary
public static final int FAVORDECSPEED

The struct member offsets.

HASHTABLEback to summary
public static final int HASHTABLE

The struct member offsets.

LOWLIMITback to summary
public static final int LOWLIMIT

The struct member offsets.

NEXTTOUPDATEback to summary
public static final int NEXTTOUPDATE

The struct member offsets.

PREFIXSTARTback to summary
public static final int PREFIXSTART

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

LZ4HCCCtxInternalback to summary
protected LZ4HCCCtxInternal(long address, ByteBuffer container)
LZ4HCCCtxInternalback to summary
public LZ4HCCCtxInternal(ByteBuffer container)

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

chainTableback to summary
public ShortBuffer chainTable()
Returns:ShortBuffer

a ShortBuffer view of the chainTable field.

Annotations
@NativeType:LZ4_u16[LZ4HC_MAXD]
chainTableback to summary
public short chainTable(int index)
Returns:short

the value at the specified index of the chainTable field.

Annotations
@NativeType:LZ4_u16
compressionLevelback to summary
public short compressionLevel()
Returns:short

the value of the compressionLevel field.

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

Returns a new LZ4HCCCtxInternal instance for the specified memory address.

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

Create a LZ4HCCCtxInternal.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static LZ4HCCCtxInternal createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
dictCtxback to summary
public LZ4HCCCtxInternal dictCtx()
Returns:LZ4HCCCtxInternal

a LZ4HCCCtxInternal view of the struct pointed to by the dictCtx field.

Annotations
@NativeType:LZ4HC_CCtx_internal * const
dictLimitback to summary
public int dictLimit()

below that point, need extDict

Annotations
@NativeType:LZ4_u32
dictStartback to summary
public ByteBuffer dictStart(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

alternate reference for extDict

Annotations
@NativeType:LZ4_byte const *
dirtyback to summary
public byte dirty()

stream has to be fully reset if this flag is set

Annotations
@NativeType:LZ4_i8
endback to summary
public ByteBuffer end(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

next block here to continue on current prefix

Annotations
@NativeType:LZ4_byte const *
favorDecSpeedback to summary
public byte favorDecSpeed()

favor decompression speed if this flag set, otherwise, favor compression ratio

Annotations
@NativeType:LZ4_i8
hashTableback to summary
public IntBuffer hashTable()
Returns:IntBuffer

a IntBuffer view of the hashTable field.

Annotations
@NativeType:LZ4_u32[LZ4HC_HASHTABLESIZE]
hashTableback to summary
public int hashTable(int index)
Returns:int

the value at the specified index of the hashTable field.

Annotations
@NativeType:LZ4_u32
lowLimitback to summary
public int lowLimit()

below that point, no more dict

Annotations
@NativeType:LZ4_u32
nchainTableback to summary
public static ShortBuffer nchainTable(long struct)

Unsafe version of chainTable.

nchainTableback to summary
public static short nchainTable(long struct, int index)

Unsafe version of chainTable.

ncompressionLevelback to summary
public static short ncompressionLevel(long struct)

Unsafe version of compressionLevel.

ndictCtxback to summary
public static LZ4HCCCtxInternal ndictCtx(long struct)

Unsafe version of dictCtx.

ndictLimitback to summary
public static int ndictLimit(long struct)

Unsafe version of dictLimit.

ndictStartback to summary
public static ByteBuffer ndictStart(long struct, int capacity)

Unsafe version of dictStart.

ndirtyback to summary
public static byte ndirty(long struct)

Unsafe version of dirty.

nendback to summary
public static ByteBuffer nend(long struct, int capacity)

Unsafe version of end.

nextToUpdateback to summary
public int nextToUpdate()

index from which to continue dictionary update

Annotations
@NativeType:LZ4_u32
nfavorDecSpeedback to summary
public static byte nfavorDecSpeed(long struct)

Unsafe version of favorDecSpeed.

nhashTableback to summary
public static IntBuffer nhashTable(long struct)

Unsafe version of hashTable.

nhashTableback to summary
public static int nhashTable(long struct, int index)

Unsafe version of hashTable.

nlowLimitback to summary
public static int nlowLimit(long struct)

Unsafe version of lowLimit.

nnextToUpdateback to summary
public static int nnextToUpdate(long struct)

Unsafe version of nextToUpdate.

nprefixStartback to summary
public static ByteBuffer nprefixStart(long struct, int capacity)

Unsafe version of prefixStart.

prefixStartback to summary
public ByteBuffer prefixStart(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

Indexes relative to this position

Annotations
@NativeType:LZ4_byte const *
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 LZ4HCCCtxInternal.Buffer

extends StructBuffer<LZ4HCCCtxInternal, LZ4HCCCtxInternal.Buffer>
Class Inheritance
An array of LZ4HCCCtxInternal structs.

Field Summary

Modifier and TypeField and Description
private static final LZ4HCCCtxInternal
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new LZ4HCCCtxInternal.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
public ShortBuffer

Returns:

a ShortBuffer view of the chainTable field.
chainTable()

public short

Returns:

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

public short

Returns:

the value of the compressionLevel field.
compressionLevel()

public LZ4HCCCtxInternal

Returns:

a LZ4HCCCtxInternal view of the struct pointed to by the dictCtx field.
dictCtx()

public int

Returns:

the value of the LZ4HCCCtxInternal#dictLimit field.
dictLimit()

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the LZ4HCCCtxInternal#dictStart field.
dictStart(int
the number of elements in the returned buffer
capacity)

public byte

Returns:

the value of the LZ4HCCCtxInternal#dirty field.
dirty()

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the LZ4HCCCtxInternal#end field.
end(int
the number of elements in the returned buffer
capacity)

public byte

Returns:

the value of the LZ4HCCCtxInternal#favorDecSpeed field.
favorDecSpeed()

protected LZ4HCCCtxInternal
getElementFactory()

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

public IntBuffer

Returns:

a IntBuffer view of the hashTable field.
hashTable()

public int

Returns:

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

public int

Returns:

the value of the LZ4HCCCtxInternal#lowLimit field.
lowLimit()

public int

Returns:

the value of the LZ4HCCCtxInternal#nextToUpdate field.
nextToUpdate()

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the LZ4HCCCtxInternal#prefixStart field.
prefixStart(int
the number of elements in the returned buffer
capacity)

protected LZ4HCCCtxInternal.Buffer
self()

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

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final LZ4HCCCtxInternal ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new LZ4HCCCtxInternal.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 LZ4HCCCtxInternal#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

chainTableback to summary
public ShortBuffer chainTable()
Returns:ShortBuffer

a ShortBuffer view of the chainTable field.

Annotations
@NativeType:LZ4_u16[LZ4HC_MAXD]
chainTableback to summary
public short chainTable(int index)
Returns:short

the value at the specified index of the chainTable field.

Annotations
@NativeType:LZ4_u16
compressionLevelback to summary
public short compressionLevel()
Returns:short

the value of the compressionLevel field.

dictCtxback to summary
public LZ4HCCCtxInternal dictCtx()
Returns:LZ4HCCCtxInternal

a LZ4HCCCtxInternal view of the struct pointed to by the dictCtx field.

Annotations
@NativeType:LZ4HC_CCtx_internal * const
dictLimitback to summary
public int dictLimit()
Returns:int

the value of the LZ4HCCCtxInternal#dictLimit field.

Annotations
@NativeType:LZ4_u32
dictStartback to summary
public ByteBuffer dictStart(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the LZ4HCCCtxInternal#dictStart field.

Annotations
@NativeType:LZ4_byte const *
dirtyback to summary
public byte dirty()
Returns:byte

the value of the LZ4HCCCtxInternal#dirty field.

Annotations
@NativeType:LZ4_i8
endback to summary
public ByteBuffer end(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the LZ4HCCCtxInternal#end field.

Annotations
@NativeType:LZ4_byte const *
favorDecSpeedback to summary
public byte favorDecSpeed()
Returns:byte

the value of the LZ4HCCCtxInternal#favorDecSpeed field.

Annotations
@NativeType:LZ4_i8
getElementFactoryback to summary
protected LZ4HCCCtxInternal getElementFactory()

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

Annotations
@Override
hashTableback to summary
public IntBuffer hashTable()
Returns:IntBuffer

a IntBuffer view of the hashTable field.

Annotations
@NativeType:LZ4_u32[LZ4HC_HASHTABLESIZE]
hashTableback to summary
public int hashTable(int index)
Returns:int

the value at the specified index of the hashTable field.

Annotations
@NativeType:LZ4_u32
lowLimitback to summary
public int lowLimit()
Returns:int

the value of the LZ4HCCCtxInternal#lowLimit field.

Annotations
@NativeType:LZ4_u32
nextToUpdateback to summary
public int nextToUpdate()
Returns:int

the value of the LZ4HCCCtxInternal#nextToUpdate field.

Annotations
@NativeType:LZ4_u32
prefixStartback to summary
public ByteBuffer prefixStart(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the LZ4HCCCtxInternal#prefixStart field.

Annotations
@NativeType:LZ4_byte const *
selfback to summary
protected LZ4HCCCtxInternal.Buffer self()

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

Annotations
@Override