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

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

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

The state struct for the XXH3 streaming API.

This structure has a strict alignment requirement of 64 bytes! Do not allocate this with malloc(), it will not be sufficiently aligned. Use XXHash.XXH3_createState() and XXHash.XXH3_freeState(org.lwjgl.util.xxhash.XXH3State), or stack allocation.

Layout


 struct XXH3_state_t {
     XXH64_hash_t acc()[8];
     unsigned char customSecret()[XXH3_SECRET_DEFAULT_SIZE];
     char[64 - (XXH3_SECRET_DEFAULT_SIZE & 63)];
     unsigned char buffer()[256];
     XXH32_hash_t bufferedSize();
     XXH32_hash_t useSeed();
     size_t nbStripesSoFar();
     XXH64_hash_t totalLen();
     size_t nbStripesPerBlock();
     size_t secretLimit();
     XXH64_hash_t seed();
     XXH64_hash_t reserved64();
     unsigned char const * extSecret(int);
 }

Nested Class Summary

Nested Classes
Modifier and Type Class Description

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

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ACC`	The struct member offsets.
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`BUFFER BUFFEREDSIZE CUSTOMSECRET EXTSECRET NBSTRIPESPERBLOCK NBSTRIPESSOFAR RESERVED64 SECRETLIMIT SEED`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`TOTALLEN USESEED`	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 Description

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`java.nio.LongBuffer`	`acc()`	the 8 accumulators.
`long`	`acc(int index)`	the 8 accumulators.
`java.nio.ByteBuffer`	`buffer()`	the internal buffer.
`byte`	`buffer(int index)`	the internal buffer.
`int`	`bufferedSize()`	the amount of memory in `buffer`, See `XXH32_state_s::memsize`.
`static XXH3State`	`calloc()`	Returns a new `XXH3State` instance allocated with `memCalloc`.
`static XXH3State.Buffer`	`calloc(int capacity)`	Returns a new `XXH3State.Buffer` instance allocated with `memCalloc`.
`static XXH3State.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `XXH3State.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static XXH3State`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `XXH3State` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static XXH3State`	`callocStack()`	Deprecated.
`static XXH3State.Buffer`	`callocStack(int capacity)`	Deprecated.
`static XXH3State.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static XXH3State`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static XXH3State`	`create()`	Returns a new `XXH3State` instance allocated with `BufferUtils`.
`static XXH3State.Buffer`	`create(int capacity)`	Returns a new `XXH3State.Buffer` instance allocated with `BufferUtils`.
`static XXH3State`	`create(long address)`	Returns a new `XXH3State` instance for the specified memory address.
`static XXH3State.Buffer`	`create(long address, int capacity)`	Create a `XXH3State.Buffer` instance at the specified memory.
`static XXH3State`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static XXH3State.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`java.nio.ByteBuffer`	`customSecret()`	used to store a custom secret generated from a seed
`byte`	`customSecret(int index)`	used to store a custom secret generated from a seed
`java.nio.ByteBuffer`	`extSecret(int capacity)`
`static XXH3State`	`malloc()`	Returns a new `XXH3State` instance allocated with `memAlloc`.
`static XXH3State.Buffer`	`malloc(int capacity)`	Returns a new `XXH3State.Buffer` instance allocated with `memAlloc`.
`static XXH3State.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `XXH3State.Buffer` instance allocated on the specified `MemoryStack`.
`static XXH3State`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `XXH3State` instance allocated on the specified `MemoryStack`.
`static XXH3State`	`mallocStack()`	Deprecated.
`static XXH3State.Buffer`	`mallocStack(int capacity)`	Deprecated.
`static XXH3State.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static XXH3State`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static java.nio.LongBuffer`	`nacc(long struct)`	Unsafe version of `acc()`.
`static long`	`nacc(long struct, int index)`	Unsafe version of `acc`.
`long`	`nbStripesPerBlock()`	number of stripes per block
`long`	`nbStripesSoFar()`	number or stripes processed
`static java.nio.ByteBuffer`	`nbuffer(long struct)`	Unsafe version of `buffer()`.
`static byte`	`nbuffer(long struct, int index)`	Unsafe version of `buffer`.
`static int`	`nbufferedSize(long struct)`	Unsafe version of `bufferedSize()`.
`static java.nio.ByteBuffer`	`ncustomSecret(long struct)`	Unsafe version of `customSecret()`.
`static byte`	`ncustomSecret(long struct, int index)`	Unsafe version of `customSecret`.
`static java.nio.ByteBuffer`	`nextSecret(long struct, int capacity)`	Unsafe version of `extSecret`.
`static long`	`nnbStripesPerBlock(long struct)`	Unsafe version of `nbStripesPerBlock()`.
`static long`	`nnbStripesSoFar(long struct)`	Unsafe version of `nbStripesSoFar()`.
`static long`	`nreserved64(long struct)`	Unsafe version of `reserved64()`.
`static long`	`nsecretLimit(long struct)`	Unsafe version of `secretLimit()`.
`static long`	`nseed(long struct)`	Unsafe version of `seed()`.
`static long`	`ntotalLen(long struct)`	Unsafe version of `totalLen()`.
`static int`	`nuseSeed(long struct)`	Unsafe version of `useSeed()`.
`long`	`reserved64()`	reserved field
`long`	`secretLimit()`	size of `customSecret` or `extSecret`
`long`	`seed()`	seed for `_withSeed` variants.
`int`	`sizeof()`
`long`	`totalLen()`	total length hashed.
`int`	`useSeed()`	reserved field.

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, validate

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - ACC, CUSTOMSECRET, BUFFER, BUFFEREDSIZE, USESEED, NBSTRIPESSOFAR, TOTALLEN, NBSTRIPESPERBLOCK, SECRETLIMIT, SEED, RESERVED64, EXTSECRET
    
    The struct member offsets.
- Constructor Detail
  - XXH3State
```
public XXH3State(java.nio.ByteBuffer container)
```
    Creates a XXH3State 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
  - acc
```
public java.nio.LongBuffer acc()

public long acc(int index)
```
    the 8 accumulators. Similar to v in XXH32_state_s and XXH64_state_s.
  - customSecret
```
public java.nio.ByteBuffer customSecret()

public byte customSecret(int index)
```
    used to store a custom secret generated from a seed
  - buffer
```
public java.nio.ByteBuffer buffer()

public byte buffer(int index)
```
    the internal buffer. See XXH32_state_s::mem32.
  - bufferedSize
```
public int bufferedSize()
```
    the amount of memory in buffer, See XXH32_state_s::memsize.
  - useSeed
```
public int useSeed()
```
    reserved field. Needed for padding on 64-bit.
  - nbStripesSoFar
```
public long nbStripesSoFar()
```
    number or stripes processed
  - totalLen
```
public long totalLen()
```
    total length hashed. 64-bit even on 32-bit targets.
  - nbStripesPerBlock
```
public long nbStripesPerBlock()
```
    number of stripes per block
  - secretLimit
```
public long secretLimit()
```
    size of customSecret or extSecret
  - seed
```
public long seed()
```
    seed for _withSeed variants. Must be zero otherwise, see XXH3_INITSTATE().
  - reserved64
```
public long reserved64()
```
    reserved field
  - extSecret
```
public java.nio.ByteBuffer extSecret(int capacity)
```
    Parameters:
    
    capacity - the number of elements in the returned buffer
    
    Returns:
    
    reference to an external secret for the _withSecret variants, NULL for other variants
  - malloc
```
public static XXH3State malloc()
```
    Returns a new XXH3State instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static XXH3State calloc()
```
    Returns a new XXH3State instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static XXH3State create()
```
    Returns a new XXH3State instance allocated with BufferUtils.
  - create
```
public static XXH3State create(long address)
```
    Returns a new XXH3State instance for the specified memory address.
  - createSafe
```
@Nullable
public static XXH3State createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static XXH3State.Buffer malloc(int capacity)
```
    Returns a new XXH3State.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static XXH3State.Buffer calloc(int capacity)
```
    Returns a new XXH3State.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static XXH3State.Buffer create(int capacity)
```
    Returns a new XXH3State.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static XXH3State.Buffer create(long address,
                                      int capacity)
```
    Create a XXH3State.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static XXH3State.Buffer createSafe(long address,
                                          int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
@Deprecated
public static XXH3State mallocStack()
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
  - callocStack
```
@Deprecated
public static XXH3State callocStack()
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
  - mallocStack
```
@Deprecated
public static XXH3State mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
  - callocStack
```
@Deprecated
public static XXH3State callocStack(org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
  - mallocStack
```
@Deprecated
public static XXH3State.Buffer mallocStack(int capacity)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
  - callocStack
```
@Deprecated
public static XXH3State.Buffer callocStack(int capacity)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
  - mallocStack
```
@Deprecated
public static XXH3State.Buffer mallocStack(int capacity,
                                           org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
  - callocStack
```
@Deprecated
public static XXH3State.Buffer callocStack(int capacity,
                                           org.lwjgl.system.MemoryStack stack)
```
    Deprecated.
    
    Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
  - malloc
```
public static XXH3State malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new XXH3State instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static XXH3State calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new XXH3State instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - malloc
```
public static XXH3State.Buffer malloc(int capacity,
                                      org.lwjgl.system.MemoryStack stack)
```
    Returns a new XXH3State.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static XXH3State.Buffer calloc(int capacity,
                                      org.lwjgl.system.MemoryStack stack)
```
    Returns a new XXH3State.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
  - nacc
```
public static java.nio.LongBuffer nacc(long struct)
```
    Unsafe version of acc().
  - nacc
```
public static long nacc(long struct,
                        int index)
```
    Unsafe version of acc.
  - ncustomSecret
```
public static java.nio.ByteBuffer ncustomSecret(long struct)
```
    Unsafe version of customSecret().
  - ncustomSecret
```
public static byte ncustomSecret(long struct,
                                 int index)
```
    Unsafe version of customSecret.
  - nbuffer
```
public static java.nio.ByteBuffer nbuffer(long struct)
```
    Unsafe version of buffer().
  - nbuffer
```
public static byte nbuffer(long struct,
                           int index)
```
    Unsafe version of buffer.
  - nbufferedSize
```
public static int nbufferedSize(long struct)
```
    Unsafe version of bufferedSize().
  - nuseSeed
```
public static int nuseSeed(long struct)
```
    Unsafe version of useSeed().
  - nnbStripesSoFar
```
public static long nnbStripesSoFar(long struct)
```
    Unsafe version of nbStripesSoFar().
  - ntotalLen
```
public static long ntotalLen(long struct)
```
    Unsafe version of totalLen().
  - nnbStripesPerBlock
```
public static long nnbStripesPerBlock(long struct)
```
    Unsafe version of nbStripesPerBlock().
  - nsecretLimit
```
public static long nsecretLimit(long struct)
```
    Unsafe version of secretLimit().
  - nseed
```
public static long nseed(long struct)
```
    Unsafe version of seed().
  - nreserved64
```
public static long nreserved64(long struct)
```
    Unsafe version of reserved64().
  - nextSecret
```
public static java.nio.ByteBuffer nextSecret(long struct,
                                             int capacity)
```
    Unsafe version of extSecret.

Class XXH3State

Layout

Nested Class Summary

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

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

ACC, CUSTOMSECRET, BUFFER, BUFFEREDSIZE, USESEED, NBSTRIPESSOFAR, TOTALLEN, NBSTRIPESPERBLOCK, SECRETLIMIT, SEED, RESERVED64, EXTSECRET

Constructor Detail

XXH3State

Method Detail

sizeof

acc

customSecret

buffer

bufferedSize

useSeed

nbStripesSoFar

totalLen

nbStripesPerBlock

secretLimit

seed

reserved64

extSecret

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nacc

nacc

ncustomSecret

ncustomSecret

nbuffer

nbuffer

nbufferedSize

nuseSeed

nnbStripesSoFar

ntotalLen

nnbStripesPerBlock

nsecretLimit

nseed

nreserved64

nextSecret