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

public Class XXH64State

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

The opaque state struct for the XXH64 streaming API.

Layout


struct XXH64_state_t {
    XXH64_hash_t total_len;
    XXH64_hash_t v[4];
    XXH64_hash_t mem64[4];
    XXH32_hash_t memsize;
    XXH32_hash_t reserved32;
    XXH64_hash_t reserved64;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XXH64State.Buffer

An array of XXH64State structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MEM64

The struct member offsets.

public static final int
MEMSIZE

The struct member offsets.

public static final int
RESERVED32

The struct member offsets.

public static final int
RESERVED64

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TOTAL_LEN

The struct member offsets.

public static final int
V

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XXH64State(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XXH64State
calloc()

Returns a new XXH64State instance allocated with memCalloc.

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

Returns a new XXH64State.Buffer instance allocated with memCalloc.

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

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

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

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

public static XXH64State
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected XXH64State
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 XXH64State
create()

Returns a new XXH64State instance allocated with BufferUtils.

public static XXH64State
create(long address)

Returns a new XXH64State instance for the specified memory address.

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

Returns a new XXH64State.Buffer instance allocated with BufferUtils.

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

Create a XXH64State.Buffer instance at the specified memory.

public static XXH64State
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XXH64State
malloc()

Returns a new XXH64State instance allocated with memAlloc.

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

Returns a new XXH64State.Buffer instance allocated with memAlloc.

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

Returns a new XXH64State instance allocated on the specified MemoryStack.

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

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

public static XXH64State
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public LongBuffer
mem64()

internal buffer for partial reads.

public long
mem64(int index)

internal buffer for partial reads.

public int
memsize()

amount of data in mem64

public static LongBuffer
nmem64(long struct)

Unsafe version of mem64.

public static long
nmem64(long struct, int index)

Unsafe version of mem64.

public static int
nmemsize(long struct)

Unsafe version of memsize.

public static int
nreserved32(long struct)

Unsafe version of reserved32.

public static long
nreserved64(long struct)

Unsafe version of reserved64.

public static long
ntotal_len(long struct)

Unsafe version of total_len.

public static LongBuffer
nv(long struct)

Unsafe version of v.

public static long
nv(long struct, int index)

Unsafe version of v.

public int
reserved32()

reserved field, needed for padding anyways

public long
reserved64()

reserved field.

public int
sizeof()

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

Returns sizeof(struct).
public long
total_len()

total length hashed.

public LongBuffer
v()

accumulator lanes

public long
v(int index)

accumulator lanes

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.

MEM64back to summary
public static final int MEM64

The struct member offsets.

MEMSIZEback to summary
public static final int MEMSIZE

The struct member offsets.

RESERVED32back to summary
public static final int RESERVED32

The struct member offsets.

RESERVED64back to summary
public static final int RESERVED64

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TOTAL_LENback to summary
public static final int TOTAL_LEN

The struct member offsets.

Vback to summary
public static final int V

The struct member offsets.

Constructor Detail

XXH64Stateback to summary
protected XXH64State(long address, ByteBuffer container)
XXH64Stateback to summary
public XXH64State(ByteBuffer container)

Creates a XXH64State 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 XXH64State calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XXH64State calloc(MemoryStack stack)

Returns a new XXH64State 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 XXH64State.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XXH64State.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 XXH64State callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static XXH64State.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 XXH64State 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 XXH64State create()

Returns a new XXH64State instance allocated with BufferUtils.

createback to summary
public static XXH64State create(long address)

Returns a new XXH64State instance for the specified memory address.

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

Returns a new XXH64State.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XXH64State.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XXH64State createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XXH64State malloc(MemoryStack stack)

Returns a new XXH64State instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XXH64State.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 XXH64State mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mem64back to summary
public LongBuffer mem64()

internal buffer for partial reads. Treated as unsigned char[32].

Annotations
@NativeType:XXH64_hash_t[4]
mem64back to summary
public long mem64(int index)

internal buffer for partial reads. Treated as unsigned char[32].

Annotations
@NativeType:XXH64_hash_t
memsizeback to summary
public int memsize()

amount of data in mem64

Annotations
@NativeType:XXH32_hash_t
nmem64back to summary
public static LongBuffer nmem64(long struct)

Unsafe version of mem64.

nmem64back to summary
public static long nmem64(long struct, int index)

Unsafe version of mem64.

nmemsizeback to summary
public static int nmemsize(long struct)

Unsafe version of memsize.

nreserved32back to summary
public static int nreserved32(long struct)

Unsafe version of reserved32.

nreserved64back to summary
public static long nreserved64(long struct)

Unsafe version of reserved64.

ntotal_lenback to summary
public static long ntotal_len(long struct)

Unsafe version of total_len.

nvback to summary
public static LongBuffer nv(long struct)

Unsafe version of v.

nvback to summary
public static long nv(long struct, int index)

Unsafe version of v.

reserved32back to summary
public int reserved32()

reserved field, needed for padding anyways

Annotations
@NativeType:XXH32_hash_t
reserved64back to summary
public long reserved64()

reserved field. Do not read or write to it.

Annotations
@NativeType:XXH64_hash_t
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
total_lenback to summary
public long total_len()

total length hashed. This is always 64-bit.

Annotations
@NativeType:XXH64_hash_t
vback to summary
public LongBuffer v()

accumulator lanes

Annotations
@NativeType:XXH64_hash_t[4]
vback to summary
public long v(int index)

accumulator lanes

Annotations
@NativeType:XXH64_hash_t
org.lwjgl.util.xxhash back to summary

public Class XXH64State.Buffer

extends StructBuffer<XXH64State, XXH64State.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XXH64State structs.

Field Summary

Modifier and TypeField and Description
private static final XXH64State

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XXH64State.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 XXH64State
public LongBuffer

Returns:

a LongBuffer view of the XXH64State#mem64 field.
mem64
()

public long

Returns:

the value at the specified index of the XXH64State#mem64 field.
mem64
(int index)

public int

Returns:

the value of the XXH64State#memsize field.
memsize
()

public int

Returns:

the value of the XXH64State#reserved32 field.
reserved32
()

public long

Returns:

the value of the XXH64State#reserved64 field.
reserved64
()

protected XXH64State.Buffer
public long

Returns:

the value of the XXH64State#total_len field.
total_len
()

public LongBuffer

Returns:

a LongBuffer view of the XXH64State#v field.
v
()

public long

Returns:

the value at the specified index of the XXH64State#v field.
v
(int index)

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XXH64State ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
mem64back to summary
public LongBuffer mem64()
Returns:LongBuffer

a LongBuffer view of the XXH64State#mem64 field.

Annotations
@NativeType:XXH64_hash_t[4]
mem64back to summary
public long mem64(int index)
Returns:long

the value at the specified index of the XXH64State#mem64 field.

Annotations
@NativeType:XXH64_hash_t
memsizeback to summary
public int memsize()
Returns:int

the value of the XXH64State#memsize field.

Annotations
@NativeType:XXH32_hash_t
reserved32back to summary
public int reserved32()
Returns:int

the value of the XXH64State#reserved32 field.

Annotations
@NativeType:XXH32_hash_t
reserved64back to summary
public long reserved64()
Returns:long

the value of the XXH64State#reserved64 field.

Annotations
@NativeType:XXH64_hash_t
selfback to summary
protected XXH64State.Buffer self()

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

Annotations
@Override
total_lenback to summary
public long total_len()
Returns:long

the value of the XXH64State#total_len field.

Annotations
@NativeType:XXH64_hash_t
vback to summary
public LongBuffer v()
Returns:LongBuffer

a LongBuffer view of the XXH64State#v field.

Annotations
@NativeType:XXH64_hash_t[4]
vback to summary
public long v(int index)
Returns:long

the value at the specified index of the XXH64State#v field.

Annotations
@NativeType:XXH64_hash_t