XXH64State (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XXH64State
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

64-bit XXH state for stack allocation. Unstable API.

Member documentation

reserved32 – required for padding anyway
reserved64 – never read nor write, might be removed in a future version

Layout


 struct XXH64_state_t {
     XXH32_hash_t total_len;
     XXH32_hash_t v1;
     XXH32_hash_t v2;
     XXH32_hash_t v3;
     XXH32_hash_t v4;
     XXH32_hash_t mem64[4];
     XXH32_hash_t memsize;
     XXH32_hash_t reserved32;
     XXH32_hash_t reserved64;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class XXH64State.Buffer
An array of XXH64State 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`	`XXH64State.Buffer` An array of `XXH64State` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`MEM64` The struct member offsets.
`static int`	`MEMSIZE` The struct member offsets.
`static int`	`RESERVED32` The struct member offsets.
`static int`	`RESERVED64` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`TOTAL_LEN` The struct member offsets.
`static int`	`V1` The struct member offsets.
`static int`	`V2` The struct member offsets.
`static int`	`V3` The struct member offsets.
`static int`	`V4` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`XXH64State(java.nio.ByteBuffer container)` Creates a `XXH64State` 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 XXH64State`	`calloc()` Returns a new `XXH64State` instance allocated with `memCalloc`.
`static XXH64State.Buffer`	`calloc(int capacity)` Returns a new `XXH64State.Buffer` instance allocated with `memCalloc`.
`static XXH64State`	`callocStack()` Returns a new `XXH64State` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static XXH64State.Buffer`	`callocStack(int capacity)` Returns a new `XXH64State.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static XXH64State.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `XXH64State.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static XXH64State`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `XXH64State` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static XXH64State`	`create()` Returns a new `XXH64State` instance allocated with `BufferUtils`.
`static XXH64State.Buffer`	`create(int capacity)` Returns a new `XXH64State.Buffer` instance allocated with `BufferUtils`.
`static XXH64State`	`create(long address)` Returns a new `XXH64State` instance for the specified memory address.
`static XXH64State.Buffer`	`create(long address, int capacity)` Create a `XXH64State.Buffer` instance at the specified memory.
`static XXH64State`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static XXH64State.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static XXH64State`	`malloc()` Returns a new `XXH64State` instance allocated with `memAlloc`.
`static XXH64State.Buffer`	`malloc(int capacity)` Returns a new `XXH64State.Buffer` instance allocated with `memAlloc`.
`static XXH64State`	`mallocStack()` Returns a new `XXH64State` instance allocated on the thread-local `MemoryStack`.
`static XXH64State.Buffer`	`mallocStack(int capacity)` Returns a new `XXH64State.Buffer` instance allocated on the thread-local `MemoryStack`.
`static XXH64State.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `XXH64State.Buffer` instance allocated on the specified `MemoryStack`.
`static XXH64State`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `XXH64State` instance allocated on the specified `MemoryStack`.
`java.nio.LongBuffer`	`mem64()` Returns a `LongBuffer` view of the `mem64` field.
`long`	`mem64(int index)` Returns the value at the specified index of the `mem64` field.
`int`	`memsize()` Returns the value of the `memsize` field.
`static java.nio.LongBuffer`	`nmem64(long struct)` Unsafe version of `mem64()`.
`static long`	`nmem64(long struct, int index)` Unsafe version of `mem64`.
`static int`	`nmemsize(long struct)` Unsafe version of `memsize()`.
`static int`	`nreserved32(long struct)` Unsafe version of `reserved32()`.
`static long`	`nreserved64(long struct)` Unsafe version of `reserved64()`.
`static long`	`ntotal_len(long struct)` Unsafe version of `total_len()`.
`static long`	`nv1(long struct)` Unsafe version of `v1()`.
`static long`	`nv2(long struct)` Unsafe version of `v2()`.
`static long`	`nv3(long struct)` Unsafe version of `v3()`.
`static long`	`nv4(long struct)` Unsafe version of `v4()`.
`int`	`reserved32()` Returns the value of the `reserved32` field.
`long`	`reserved64()` Returns the value of the `reserved64` field.
`int`	`sizeof()`
`long`	`total_len()` Returns the value of the `total_len` field.
`long`	`v1()` Returns the value of the `v1` field.
`long`	`v2()` Returns the value of the `v2` field.
`long`	`v3()` Returns the value of the `v3` field.
`long`	`v4()` Returns the value of the `v4` field.

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.
  - TOTAL_LEN
```
public static final int TOTAL_LEN
```
    The struct member offsets.
  - V1
```
public static final int V1
```
    The struct member offsets.
  - V2
```
public static final int V2
```
    The struct member offsets.
  - V3
```
public static final int V3
```
    The struct member offsets.
  - V4
```
public static final int V4
```
    The struct member offsets.
  - MEM64
```
public static final int MEM64
```
    The struct member offsets.
  - MEMSIZE
```
public static final int MEMSIZE
```
    The struct member offsets.
  - RESERVED32
```
public static final int RESERVED32
```
    The struct member offsets.
  - RESERVED64
```
public static final int RESERVED64
```
    The struct member offsets.
- Constructor Detail
  - XXH64State
```
public XXH64State(java.nio.ByteBuffer container)
```
    Creates a XXH64State 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
  - total_len
```
public long total_len()
```
    Returns the value of the total_len field.
  - v1
```
public long v1()
```
    Returns the value of the v1 field.
  - v2
```
public long v2()
```
    Returns the value of the v2 field.
  - v3
```
public long v3()
```
    Returns the value of the v3 field.
  - v4
```
public long v4()
```
    Returns the value of the v4 field.
  - mem64
```
public java.nio.LongBuffer mem64()
```
    Returns a LongBuffer view of the mem64 field.
  - mem64
```
public long mem64(int index)
```
    Returns the value at the specified index of the mem64 field.
  - memsize
```
public int memsize()
```
    Returns the value of the memsize field.
  - reserved32
```
public int reserved32()
```
    Returns the value of the reserved32 field.
  - reserved64
```
public long reserved64()
```
    Returns the value of the reserved64 field.
  - malloc
```
public static XXH64State malloc()
```
    Returns a new XXH64State instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static XXH64State calloc()
```
    Returns a new XXH64State instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static XXH64State create()
```
    Returns a new XXH64State instance allocated with BufferUtils.
  - create
```
public static XXH64State create(long address)
```
    Returns a new XXH64State instance for the specified memory address.
  - createSafe
```
@Nullable
public static XXH64State createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static XXH64State.Buffer malloc(int capacity)
```
    Returns a new XXH64State.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static XXH64State.Buffer calloc(int capacity)
```
    Returns a new XXH64State.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static XXH64State.Buffer create(int capacity)
```
    Returns a new XXH64State.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static XXH64State.Buffer create(long address,
                                       int capacity)
```
    Create a XXH64State.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static XXH64State.Buffer createSafe(long address,
                                                     int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static XXH64State mallocStack()
```
    Returns a new XXH64State instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static XXH64State callocStack()
```
    Returns a new XXH64State instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static XXH64State mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new XXH64State instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static XXH64State callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new XXH64State instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static XXH64State.Buffer mallocStack(int capacity)
```
    Returns a new XXH64State.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static XXH64State.Buffer callocStack(int capacity)
```
    Returns a new XXH64State.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static XXH64State.Buffer mallocStack(int capacity,
                                            org.lwjgl.system.MemoryStack stack)
```
    Returns a new XXH64State.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static XXH64State.Buffer callocStack(int capacity,
                                            org.lwjgl.system.MemoryStack stack)
```
    Returns a new XXH64State.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
  - ntotal_len
```
public static long ntotal_len(long struct)
```
    Unsafe version of total_len().
  - nv1
```
public static long nv1(long struct)
```
    Unsafe version of v1().
  - nv2
```
public static long nv2(long struct)
```
    Unsafe version of v2().
  - nv3
```
public static long nv3(long struct)
```
    Unsafe version of v3().
  - nv4
```
public static long nv4(long struct)
```
    Unsafe version of v4().
  - nmem64
```
public static java.nio.LongBuffer nmem64(long struct)
```
    Unsafe version of mem64().
  - nmem64
```
public static long nmem64(long struct,
                          int index)
```
    Unsafe version of mem64.
  - nmemsize
```
public static int nmemsize(long struct)
```
    Unsafe version of memsize().
  - nreserved32
```
public static int nreserved32(long struct)
```
    Unsafe version of reserved32().
  - nreserved64
```
public static long nreserved64(long struct)
```
    Unsafe version of reserved64().

Class XXH64State

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

TOTAL_LEN

V1

V2

V3

V4

MEM64

MEMSIZE

RESERVED32

RESERVED64

Constructor Detail

XXH64State

Method Detail

sizeof

total_len

v1

v2

v3

v4

mem64

mem64

memsize

reserved32

reserved64

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ntotal_len

nv1

nv2

nv3

nv4

nmem64

nmem64

nmemsize

nreserved32

nreserved64