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

public Class XXH128Hash

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

The return value from 128-bit hashes.

Stored in little endian order, although the fields themselves are in native endianness.

Layout


struct XXH128_hash_t {
    XXH64_hash_t low64;
    XXH64_hash_t high64;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XXH128Hash.Buffer

An array of XXH128Hash structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
HIGH64

The struct member offsets.

public static final int
LOW64

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

public
XXH128Hash(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XXH128Hash
calloc()

Returns a new XXH128Hash instance allocated with memCalloc.

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

Returns a new XXH128Hash.Buffer instance allocated with memCalloc.

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

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

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

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

public static XXH128Hash
callocStack()

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

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

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

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

Returns a new XXH128Hash instance allocated with BufferUtils.

public static XXH128Hash
create(long address)

Returns a new XXH128Hash instance for the specified memory address.

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

Returns a new XXH128Hash.Buffer instance allocated with BufferUtils.

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

Create a XXH128Hash.Buffer instance at the specified memory.

public static XXH128Hash
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
high64()

value >> 64

public long
low64()

value & 0xFFFFFFFFFFFFFFFF

public static XXH128Hash
malloc()

Returns a new XXH128Hash instance allocated with memAlloc.

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

Returns a new XXH128Hash.Buffer instance allocated with memAlloc.

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

Returns a new XXH128Hash instance allocated on the specified MemoryStack.

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

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

public static XXH128Hash
mallocStack()

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

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

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

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

Unsafe version of high64.

public static long
nlow64(long struct)

Unsafe version of low64.

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.

HIGH64back to summary
public static final int HIGH64

The struct member offsets.

LOW64back to summary
public static final int LOW64

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

XXH128Hashback to summary
protected XXH128Hash(long address, ByteBuffer container)
XXH128Hashback to summary
public XXH128Hash(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XXH128Hash calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new XXH128Hash instance allocated with BufferUtils.

createback to summary
public static XXH128Hash create(long address)

Returns a new XXH128Hash instance for the specified memory address.

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

Returns a new XXH128Hash.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XXH128Hash.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XXH128Hash createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
high64back to summary
public long high64()

value >> 64

Annotations
@NativeType:XXH64_hash_t
low64back to summary
public long low64()

value & 0xFFFFFFFFFFFFFFFF

Annotations
@NativeType:XXH64_hash_t
mallocback to summary
public static XXH128Hash malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XXH128Hash malloc(MemoryStack stack)

Returns a new XXH128Hash instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nhigh64back to summary
public static long nhigh64(long struct)

Unsafe version of high64.

nlow64back to summary
public static long nlow64(long struct)

Unsafe version of low64.

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.xxhash back to summary

public Class XXH128Hash.Buffer

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

An array of XXH128Hash structs.

Field Summary

Modifier and TypeField and Description
private static final XXH128Hash

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XXH128Hash.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 XXH128Hash
public long

Returns:

the value of the XXH128Hash#high64 field.
high64
()

public long

Returns:

the value of the XXH128Hash#low64 field.
low64
()

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XXH128Hash ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
high64back to summary
public long high64()
Returns:long

the value of the XXH128Hash#high64 field.

Annotations
@NativeType:XXH64_hash_t
low64back to summary
public long low64()
Returns:long

the value of the XXH128Hash#low64 field.

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

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

Annotations
@Override