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

public Class XXH32State

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

The opaque state struct for the XXH32 streaming API.

Layout


struct XXH32_state_t {
    XXH32_hash_t total_len_32;
    XXH32_hash_t large_len;
    XXH32_hash_t v[4];
    XXH32_hash_t mem32[4];
    XXH32_hash_t memsize;
    XXH32_hash_t reserved;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XXH32State.Buffer

An array of XXH32State structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
LARGE_LEN

The struct member offsets.

public static final int
MEM32

The struct member offsets.

public static final int
MEMSIZE

The struct member offsets.

public static final int
RESERVED

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TOTAL_LEN_32

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

public
XXH32State(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XXH32State
calloc()

Returns a new XXH32State instance allocated with memCalloc.

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

Returns a new XXH32State.Buffer instance allocated with memCalloc.

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

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

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

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

public static XXH32State
callocStack()

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

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

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

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

Returns a new XXH32State instance allocated with BufferUtils.

public static XXH32State
create(long address)

Returns a new XXH32State instance for the specified memory address.

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

Returns a new XXH32State.Buffer instance allocated with BufferUtils.

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

Create a XXH32State.Buffer instance at the specified memory.

public static XXH32State
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
large_len()

whether the hash is ≥ 16 (handles total_len_32 overflow)

public static XXH32State
malloc()

Returns a new XXH32State instance allocated with memAlloc.

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

Returns a new XXH32State.Buffer instance allocated with memAlloc.

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

Returns a new XXH32State instance allocated on the specified MemoryStack.

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

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

public static XXH32State
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public IntBuffer
mem32()

internal buffer for partial reads.

public int
mem32(int index)

internal buffer for partial reads.

public int
memsize()

amount of data in mem32

public static int
nlarge_len(long struct)

Unsafe version of large_len.

public static IntBuffer
nmem32(long struct)

Unsafe version of mem32.

public static int
nmem32(long struct, int index)

Unsafe version of mem32.

public static int
nmemsize(long struct)

Unsafe version of memsize.

public static int
nreserved(long struct)

Unsafe version of reserved.

public static int
ntotal_len_32(long struct)

Unsafe version of total_len_32.

public static IntBuffer
nv(long struct)

Unsafe version of v.

public static int
nv(long struct, int index)

Unsafe version of v.

public int
reserved()

reserved field.

public int
sizeof()

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

Returns sizeof(struct).
public int
total_len_32()

total length hashed, modulo 2^32

public IntBuffer
v()

accumulator lanes

public int
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.

LARGE_LENback to summary
public static final int LARGE_LEN

The struct member offsets.

MEM32back to summary
public static final int MEM32

The struct member offsets.

MEMSIZEback to summary
public static final int MEMSIZE

The struct member offsets.

RESERVEDback to summary
public static final int RESERVED

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TOTAL_LEN_32back to summary
public static final int TOTAL_LEN_32

The struct member offsets.

Vback to summary
public static final int V

The struct member offsets.

Constructor Detail

XXH32Stateback to summary
protected XXH32State(long address, ByteBuffer container)
XXH32Stateback to summary
public XXH32State(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XXH32State calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new XXH32State instance allocated with BufferUtils.

createback to summary
public static XXH32State create(long address)

Returns a new XXH32State instance for the specified memory address.

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

Returns a new XXH32State.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XXH32State.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XXH32State createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
large_lenback to summary
public int large_len()

whether the hash is ≥ 16 (handles total_len_32 overflow)

Annotations
@NativeType:XXH32_hash_t
mallocback to summary
public static XXH32State malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XXH32State malloc(MemoryStack stack)

Returns a new XXH32State instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mem32back to summary
public IntBuffer mem32()

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

Annotations
@NativeType:XXH32_hash_t[4]
mem32back to summary
public int mem32(int index)

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

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

amount of data in mem32

Annotations
@NativeType:XXH32_hash_t
nlarge_lenback to summary
public static int nlarge_len(long struct)

Unsafe version of large_len.

nmem32back to summary
public static IntBuffer nmem32(long struct)

Unsafe version of mem32.

nmem32back to summary
public static int nmem32(long struct, int index)

Unsafe version of mem32.

nmemsizeback to summary
public static int nmemsize(long struct)

Unsafe version of memsize.

nreservedback to summary
public static int nreserved(long struct)

Unsafe version of reserved.

ntotal_len_32back to summary
public static int ntotal_len_32(long struct)

Unsafe version of total_len_32.

nvback to summary
public static IntBuffer nv(long struct)

Unsafe version of v.

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

Unsafe version of v.

reservedback to summary
public int reserved()

reserved field. Do not read nor write to it.

Annotations
@NativeType:XXH32_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_len_32back to summary
public int total_len_32()

total length hashed, modulo 2^32

Annotations
@NativeType:XXH32_hash_t
vback to summary
public IntBuffer v()

accumulator lanes

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

accumulator lanes

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

public Class XXH32State.Buffer

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

An array of XXH32State structs.

Field Summary

Modifier and TypeField and Description
private static final XXH32State

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XXH32State.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 XXH32State
public int

Returns:

the value of the XXH32State#large_len field.
large_len
()

public IntBuffer

Returns:

a IntBuffer view of the XXH32State#mem32 field.
mem32
()

public int

Returns:

the value at the specified index of the XXH32State#mem32 field.
mem32
(int index)

public int

Returns:

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

public int

Returns:

the value of the XXH32State#reserved field.
reserved
()

protected XXH32State.Buffer
public int

Returns:

the value of the XXH32State#total_len_32 field.
total_len_32
()

public IntBuffer

Returns:

a IntBuffer view of the XXH32State#v field.
v
()

public int

Returns:

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

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XXH32State ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
large_lenback to summary
public int large_len()
Returns:int

the value of the XXH32State#large_len field.

Annotations
@NativeType:XXH32_hash_t
mem32back to summary
public IntBuffer mem32()
Returns:IntBuffer

a IntBuffer view of the XXH32State#mem32 field.

Annotations
@NativeType:XXH32_hash_t[4]
mem32back to summary
public int mem32(int index)
Returns:int

the value at the specified index of the XXH32State#mem32 field.

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

the value of the XXH32State#memsize field.

Annotations
@NativeType:XXH32_hash_t
reservedback to summary
public int reserved()
Returns:int

the value of the XXH32State#reserved field.

Annotations
@NativeType:XXH32_hash_t
selfback to summary
protected XXH32State.Buffer self()

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

Annotations
@Override
total_len_32back to summary
public int total_len_32()
Returns:int

the value of the XXH32State#total_len_32 field.

Annotations
@NativeType:XXH32_hash_t
vback to summary
public IntBuffer v()
Returns:IntBuffer

a IntBuffer view of the XXH32State#v field.

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

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

Annotations
@NativeType:XXH32_hash_t