java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.util.xxhash.XXH128Canonical

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer
```
public class XXH128Canonical
extends Struct
implements NativeResource
```
128-bit canonical representation.
Member documentation
- digest[16] – the digest in canonical representation
Layout
```
 struct XXH128_canonical_t {
     unsigned char digest[16];
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class XXH128Canonical.Buffer
An array of XXH128Canonical structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  Pointer.Default

Field Summary

Fields
Modifier and Type Field Description

static int ALIGNOF
The struct alignment in bytes.

static int DIGEST
The struct member offsets.

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor Description

XXH128Canonical(java.nio.ByteBuffer container)
Creates a XXH128Canonical instance at the current position of the specified ByteBuffer container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static XXH128Canonical`	`calloc()`	Returns a new `XXH128Canonical` instance allocated with `memCalloc`.
`static XXH128Canonical.Buffer`	`calloc(int capacity)`	Returns a new `XXH128Canonical.Buffer` instance allocated with `memCalloc`.
`static XXH128Canonical`	`callocStack()`	Returns a new `XXH128Canonical` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static XXH128Canonical.Buffer`	`callocStack(int capacity)`	Returns a new `XXH128Canonical.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static XXH128Canonical.Buffer`	`callocStack(int capacity, MemoryStack stack)`	Returns a new `XXH128Canonical.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static XXH128Canonical`	`callocStack(MemoryStack stack)`	Returns a new `XXH128Canonical` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static XXH128Canonical`	`create()`	Returns a new `XXH128Canonical` instance allocated with `BufferUtils`.
`static XXH128Canonical.Buffer`	`create(int capacity)`	Returns a new `XXH128Canonical.Buffer` instance allocated with `BufferUtils`.
`static XXH128Canonical`	`create(long address)`	Returns a new `XXH128Canonical` instance for the specified memory address.
`static XXH128Canonical.Buffer`	`create(long address, int capacity)`	Create a `XXH128Canonical.Buffer` instance at the specified memory.
`static XXH128Canonical`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static XXH128Canonical.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`java.nio.ByteBuffer`	`digest()`	Returns a `ByteBuffer` view of the `digest` field.
`byte`	`digest(int index)`	Returns the value at the specified index of the `digest` field.
`static XXH128Canonical`	`malloc()`	Returns a new `XXH128Canonical` instance allocated with `memAlloc`.
`static XXH128Canonical.Buffer`	`malloc(int capacity)`	Returns a new `XXH128Canonical.Buffer` instance allocated with `memAlloc`.
`static XXH128Canonical`	`mallocStack()`	Returns a new `XXH128Canonical` instance allocated on the thread-local `MemoryStack`.
`static XXH128Canonical.Buffer`	`mallocStack(int capacity)`	Returns a new `XXH128Canonical.Buffer` instance allocated on the thread-local `MemoryStack`.
`static XXH128Canonical.Buffer`	`mallocStack(int capacity, MemoryStack stack)`	Returns a new `XXH128Canonical.Buffer` instance allocated on the specified `MemoryStack`.
`static XXH128Canonical`	`mallocStack(MemoryStack stack)`	Returns a new `XXH128Canonical` instance allocated on the specified `MemoryStack`.
`static java.nio.ByteBuffer`	`ndigest(long struct)`	Unsafe version of `digest()`.
`static byte`	`ndigest(long struct, int index)`	Unsafe version of `digest`.
`int`	`sizeof()`	Returns `sizeof(struct)`.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - DIGEST
```
public static final int DIGEST
```
    The struct member offsets.
- Constructor Detail
  - XXH128Canonical
```
public XXH128Canonical(java.nio.ByteBuffer container)
```
    Creates a XXH128Canonical 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
  - sizeof
```
public int sizeof()
```
    Description copied from class: Struct
    
    Returns sizeof(struct).
    
    Specified by:
    
    sizeof in class Struct
  - digest
```
public java.nio.ByteBuffer digest()
```
    Returns a ByteBuffer view of the digest field.
  - digest
```
public byte digest(int index)
```
    Returns the value at the specified index of the digest field.
  - malloc
```
public static XXH128Canonical malloc()
```
    Returns a new XXH128Canonical instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static XXH128Canonical calloc()
```
    Returns a new XXH128Canonical instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static XXH128Canonical create()
```
    Returns a new XXH128Canonical instance allocated with BufferUtils.
  - create
```
public static XXH128Canonical create(long address)
```
    Returns a new XXH128Canonical instance for the specified memory address.
  - createSafe
```
@Nullable
public static XXH128Canonical createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static XXH128Canonical.Buffer malloc(int capacity)
```
    Returns a new XXH128Canonical.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static XXH128Canonical.Buffer calloc(int capacity)
```
    Returns a new XXH128Canonical.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static XXH128Canonical.Buffer create(int capacity)
```
    Returns a new XXH128Canonical.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static XXH128Canonical.Buffer create(long address,
                                            int capacity)
```
    Create a XXH128Canonical.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static XXH128Canonical.Buffer createSafe(long address,
                                                int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static XXH128Canonical mallocStack()
```
    Returns a new XXH128Canonical instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static XXH128Canonical callocStack()
```
    Returns a new XXH128Canonical instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static XXH128Canonical mallocStack(MemoryStack stack)
```
    Returns a new XXH128Canonical instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static XXH128Canonical callocStack(MemoryStack stack)
```
    Returns a new XXH128Canonical instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static XXH128Canonical.Buffer mallocStack(int capacity)
```
    Returns a new XXH128Canonical.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static XXH128Canonical.Buffer callocStack(int capacity)
```
    Returns a new XXH128Canonical.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static XXH128Canonical.Buffer mallocStack(int capacity,
                                                 MemoryStack stack)
```
    Returns a new XXH128Canonical.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static XXH128Canonical.Buffer callocStack(int capacity,
                                                 MemoryStack stack)
```
    Returns a new XXH128Canonical.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - ndigest
```
public static java.nio.ByteBuffer ndigest(long struct)
```
    Unsafe version of digest().
  - ndigest
```
public static byte ndigest(long struct,
                           int index)
```
    Unsafe version of digest.

Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`DIGEST`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.

Class XXH128Canonical

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

DIGEST

Constructor Detail

XXH128Canonical

Method Detail

sizeof

digest

digest

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ndigest

ndigest