XXH64Canonical (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class XXH64Canonical
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
64-bit canonical representation.
Member documentation
- digest[8] – the digest in canonical representation
Layout
```
 struct XXH64_canonical_t {
     unsigned char digest[8];
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`XXH64Canonical.Buffer` An array of `XXH64Canonical` structs.

Field Summary

Fields
Modifier and Type Field and 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

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

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`XXH64Canonical(java.nio.ByteBuffer container)` Creates a `XXH64Canonical` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static XXH64Canonical`	`calloc()` Returns a new `XXH64Canonical` instance allocated with `memCalloc`.
`static XXH64Canonical.Buffer`	`calloc(int capacity)` Returns a new `XXH64Canonical.Buffer` instance allocated with `memCalloc`.
`static XXH64Canonical`	`callocStack()` Returns a new `XXH64Canonical` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static XXH64Canonical.Buffer`	`callocStack(int capacity)` Returns a new `XXH64Canonical.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static XXH64Canonical.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `XXH64Canonical.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static XXH64Canonical`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `XXH64Canonical` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static XXH64Canonical`	`create()` Returns a new `XXH64Canonical` instance allocated with `BufferUtils`.
`static XXH64Canonical.Buffer`	`create(int capacity)` Returns a new `XXH64Canonical.Buffer` instance allocated with `BufferUtils`.
`static XXH64Canonical`	`create(long address)` Returns a new `XXH64Canonical` instance for the specified memory address.
`static XXH64Canonical.Buffer`	`create(long address, int capacity)` Create a `XXH64Canonical.Buffer` instance at the specified memory.
`static XXH64Canonical`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static XXH64Canonical.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 XXH64Canonical`	`malloc()` Returns a new `XXH64Canonical` instance allocated with `memAlloc`.
`static XXH64Canonical.Buffer`	`malloc(int capacity)` Returns a new `XXH64Canonical.Buffer` instance allocated with `memAlloc`.
`static XXH64Canonical`	`mallocStack()` Returns a new `XXH64Canonical` instance allocated on the thread-local `MemoryStack`.
`static XXH64Canonical.Buffer`	`mallocStack(int capacity)` Returns a new `XXH64Canonical.Buffer` instance allocated on the thread-local `MemoryStack`.
`static XXH64Canonical.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `XXH64Canonical.Buffer` instance allocated on the specified `MemoryStack`.
`static XXH64Canonical`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `XXH64Canonical` 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()`

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

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

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

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

- 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
  - XXH64Canonical
```
public XXH64Canonical(java.nio.ByteBuffer container)
```
    Creates a XXH64Canonical 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.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 XXH64Canonical malloc()
```
    Returns a new XXH64Canonical instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static XXH64Canonical calloc()
```
    Returns a new XXH64Canonical instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static XXH64Canonical create()
```
    Returns a new XXH64Canonical instance allocated with BufferUtils.
  - create
```
public static XXH64Canonical create(long address)
```
    Returns a new XXH64Canonical instance for the specified memory address.
  - createSafe
```
@Nullable
public static XXH64Canonical createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static XXH64Canonical.Buffer malloc(int capacity)
```
    Returns a new XXH64Canonical.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static XXH64Canonical.Buffer calloc(int capacity)
```
    Returns a new XXH64Canonical.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static XXH64Canonical.Buffer create(int capacity)
```
    Returns a new XXH64Canonical.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static XXH64Canonical.Buffer create(long address,
                                           int capacity)
```
    Create a XXH64Canonical.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static XXH64Canonical.Buffer createSafe(long address,
                                                         int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static XXH64Canonical mallocStack()
```
    Returns a new XXH64Canonical instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static XXH64Canonical callocStack()
```
    Returns a new XXH64Canonical instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static XXH64Canonical mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new XXH64Canonical instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static XXH64Canonical callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new XXH64Canonical instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static XXH64Canonical.Buffer mallocStack(int capacity)
```
    Returns a new XXH64Canonical.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static XXH64Canonical.Buffer callocStack(int capacity)
```
    Returns a new XXH64Canonical.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static XXH64Canonical.Buffer mallocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new XXH64Canonical.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static XXH64Canonical.Buffer callocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new XXH64Canonical.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.

Class XXH64Canonical

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 class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

DIGEST

Constructor Detail

XXH64Canonical

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