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

public Class XXH32Canonical

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

Canonical (big endian) representation of XXH32_hash_t.

Layout


struct XXH32_canonical_t {
    unsigned char digest[4];
}

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
DIGEST

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

public
XXH32Canonical(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XXH32Canonical
calloc()

Returns a new XXH32Canonical instance allocated with memCalloc.

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

Returns a new XXH32Canonical.Buffer instance allocated with memCalloc.

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

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

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

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

public static XXH32Canonical
callocStack()

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

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

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

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

Returns a new XXH32Canonical instance allocated with BufferUtils.

public static XXH32Canonical
create(long address)

Returns a new XXH32Canonical instance for the specified memory address.

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

Returns a new XXH32Canonical.Buffer instance allocated with BufferUtils.

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

Create a XXH32Canonical.Buffer instance at the specified memory.

public static XXH32Canonical
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer
digest()

hash bytes, big endian

public byte
digest(int index)

hash bytes, big endian

public static XXH32Canonical
malloc()

Returns a new XXH32Canonical instance allocated with memAlloc.

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

Returns a new XXH32Canonical.Buffer instance allocated with memAlloc.

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

Returns a new XXH32Canonical instance allocated on the specified MemoryStack.

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

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

public static XXH32Canonical
mallocStack()

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

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

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

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

Unsafe version of digest.

public static byte
ndigest(long struct, int index)

Unsafe version of digest.

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.

DIGESTback to summary
public static final int DIGEST

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

XXH32Canonicalback to summary
protected XXH32Canonical(long address, ByteBuffer container)
XXH32Canonicalback to summary
public XXH32Canonical(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XXH32Canonical calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new XXH32Canonical instance allocated with BufferUtils.

createback to summary
public static XXH32Canonical create(long address)

Returns a new XXH32Canonical instance for the specified memory address.

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

Returns a new XXH32Canonical.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XXH32Canonical.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XXH32Canonical createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
digestback to summary
public ByteBuffer digest()

hash bytes, big endian

Annotations
@NativeType:unsigned char[4]
digestback to summary
public byte digest(int index)

hash bytes, big endian

Annotations
@NativeType:unsigned char
mallocback to summary
public static XXH32Canonical malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XXH32Canonical malloc(MemoryStack stack)

Returns a new XXH32Canonical instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ndigestback to summary
public static ByteBuffer ndigest(long struct)

Unsafe version of digest.

ndigestback to summary
public static byte ndigest(long struct, int index)

Unsafe version of digest.

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 XXH32Canonical.Buffer

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

An array of XXH32Canonical structs.

Field Summary

Modifier and TypeField and Description
private static final XXH32Canonical

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XXH32Canonical.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 ByteBuffer

Returns:

a ByteBuffer view of the XXH32Canonical#digest field.
digest
()

public byte

Returns:

the value at the specified index of the XXH32Canonical#digest field.
digest
(int index)

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XXH32Canonical ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

digestback to summary
public ByteBuffer digest()
Returns:ByteBuffer

a ByteBuffer view of the XXH32Canonical#digest field.

Annotations
@NativeType:unsigned char[4]
digestback to summary
public byte digest(int index)
Returns:byte

the value at the specified index of the XXH32Canonical#digest field.

Annotations
@NativeType:unsigned char
getElementFactoryback to summary
protected XXH32Canonical getElementFactory()

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

Annotations
@Override
selfback to summary
protected XXH32Canonical.Buffer self()

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

Annotations
@Override