XXH3State (LWJGL 3.2.4 SNAPSHOT

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

XXH3 state for stack allocation. Unstable API.

Layout


 struct XXH3_state_t {
     XXH32_hash_t acc[8];
     unsigned char customSecret[192];
     unsigned char buffer[256];
     XXH32_hash_t bufferedSize;
     XXH32_hash_t nbStripesPerBlock;
     XXH32_hash_t nbStripesSoFar;
     XXH32_hash_t secretLimit;
     XXH32_hash_t reserved32;
     XXH32_hash_t reserved32_2;
     XXH32_hash_t totalLen;
     XXH32_hash_t seed;
     XXH32_hash_t reserved64;
     unsigned char const * secret;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and 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
Modifier and Type	Class and Description
`static class`	`XXH3State.Buffer` An array of `XXH3State` structs.

Field Summary

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

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

Constructors
Constructor and 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
Modifier and Type	Method and Description
`java.nio.LongBuffer`	`acc()` Returns a `LongBuffer` view of the `acc` field.
`long`	`acc(int index)` Returns the value at the specified index of the `acc` field.
`java.nio.ByteBuffer`	`buffer()` Returns a `ByteBuffer` view of the `buffer` field.
`byte`	`buffer(int index)` Returns the value at the specified index of the `buffer` field.
`int`	`bufferedSize()` Returns the value of the `bufferedSize` field.
`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`	`callocStack()` Returns a new `XXH3State` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static XXH3State.Buffer`	`callocStack(int capacity)` Returns a new `XXH3State.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static XXH3State.Buffer`	`callocStack(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`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `XXH3State` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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()` Returns a `ByteBuffer` view of the `customSecret` field.
`byte`	`customSecret(int index)` Returns the value at the specified index of the `customSecret` field.
`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`	`mallocStack()` Returns a new `XXH3State` instance allocated on the thread-local `MemoryStack`.
`static XXH3State.Buffer`	`mallocStack(int capacity)` Returns a new `XXH3State.Buffer` instance allocated on the thread-local `MemoryStack`.
`static XXH3State.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `XXH3State.Buffer` instance allocated on the specified `MemoryStack`.
`static XXH3State`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `XXH3State` instance allocated on the specified `MemoryStack`.
`static java.nio.LongBuffer`	`nacc(long struct)` Unsafe version of `acc()`.
`static long`	`nacc(long struct, int index)` Unsafe version of `acc`.
`int`	`nbStripesPerBlock()` Returns the value of the `nbStripesPerBlock` field.
`int`	`nbStripesSoFar()` Returns the value of the `nbStripesSoFar` field.
`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 int`	`nnbStripesPerBlock(long struct)` Unsafe version of `nbStripesPerBlock()`.
`static int`	`nnbStripesSoFar(long struct)` Unsafe version of `nbStripesSoFar()`.
`static int`	`nreserved32_2(long struct)` Unsafe version of `reserved32_2()`.
`static int`	`nreserved32(long struct)` Unsafe version of `reserved32()`.
`static long`	`nreserved64(long struct)` Unsafe version of `reserved64()`.
`static java.nio.ByteBuffer`	`nsecret(long struct, int capacity)` Unsafe version of `secret`.
`static int`	`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()`.
`int`	`reserved32_2()` Returns the value of the `reserved32_2` field.
`int`	`reserved32()` Returns the value of the `reserved32` field.
`long`	`reserved64()` Returns the value of the `reserved64` field.
`java.nio.ByteBuffer`	`secret(int capacity)` Returns a `ByteBuffer` view of the data pointed to by the `secret` field.
`int`	`secretLimit()` Returns the value of the `secretLimit` field.
`long`	`seed()` Returns the value of the `seed` field.
`int`	`sizeof()`
`long`	`totalLen()` Returns the value of the `totalLen` 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.
  - ACC
```
public static final int ACC
```
    The struct member offsets.
  - CUSTOMSECRET
```
public static final int CUSTOMSECRET
```
    The struct member offsets.
  - BUFFER
```
public static final int BUFFER
```
    The struct member offsets.
  - BUFFEREDSIZE
```
public static final int BUFFEREDSIZE
```
    The struct member offsets.
  - NBSTRIPESPERBLOCK
```
public static final int NBSTRIPESPERBLOCK
```
    The struct member offsets.
  - NBSTRIPESSOFAR
```
public static final int NBSTRIPESSOFAR
```
    The struct member offsets.
  - SECRETLIMIT
```
public static final int SECRETLIMIT
```
    The struct member offsets.
  - RESERVED32
```
public static final int RESERVED32
```
    The struct member offsets.
  - RESERVED32_2
```
public static final int RESERVED32_2
```
    The struct member offsets.
  - TOTALLEN
```
public static final int TOTALLEN
```
    The struct member offsets.
  - SEED
```
public static final int SEED
```
    The struct member offsets.
  - RESERVED64
```
public static final int RESERVED64
```
    The struct member offsets.
  - SECRET
```
public static final int SECRET
```
    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()
```
    Returns a LongBuffer view of the acc field.
  - acc
```
public long acc(int index)
```
    Returns the value at the specified index of the acc field.
  - customSecret
```
public java.nio.ByteBuffer customSecret()
```
    Returns a ByteBuffer view of the customSecret field.
  - customSecret
```
public byte customSecret(int index)
```
    Returns the value at the specified index of the customSecret field.
  - buffer
```
public java.nio.ByteBuffer buffer()
```
    Returns a ByteBuffer view of the buffer field.
  - buffer
```
public byte buffer(int index)
```
    Returns the value at the specified index of the buffer field.
  - bufferedSize
```
public int bufferedSize()
```
    Returns the value of the bufferedSize field.
  - nbStripesPerBlock
```
public int nbStripesPerBlock()
```
    Returns the value of the nbStripesPerBlock field.
  - nbStripesSoFar
```
public int nbStripesSoFar()
```
    Returns the value of the nbStripesSoFar field.
  - secretLimit
```
public int secretLimit()
```
    Returns the value of the secretLimit field.
  - reserved32
```
public int reserved32()
```
    Returns the value of the reserved32 field.
  - reserved32_2
```
public int reserved32_2()
```
    Returns the value of the reserved32_2 field.
  - totalLen
```
public long totalLen()
```
    Returns the value of the totalLen field.
  - seed
```
public long seed()
```
    Returns the value of the seed field.
  - reserved64
```
public long reserved64()
```
    Returns the value of the reserved64 field.
  - secret
```
public java.nio.ByteBuffer secret(int capacity)
```
    Returns a ByteBuffer view of the data pointed to by the secret field.
    
    Parameters:
    
    capacity - the number of elements in the returned buffer
  - 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
```
public static XXH3State mallocStack()
```
    Returns a new XXH3State instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static XXH3State callocStack()
```
    Returns a new XXH3State instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static XXH3State mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new XXH3State instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static XXH3State callocStack(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
  - mallocStack
```
public static XXH3State.Buffer mallocStack(int capacity)
```
    Returns a new XXH3State.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static XXH3State.Buffer callocStack(int capacity)
```
    Returns a new XXH3State.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static XXH3State.Buffer mallocStack(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
  - callocStack
```
public static XXH3State.Buffer callocStack(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().
  - nnbStripesPerBlock
```
public static int nnbStripesPerBlock(long struct)
```
    Unsafe version of nbStripesPerBlock().
  - nnbStripesSoFar
```
public static int nnbStripesSoFar(long struct)
```
    Unsafe version of nbStripesSoFar().
  - nsecretLimit
```
public static int nsecretLimit(long struct)
```
    Unsafe version of secretLimit().
  - nreserved32
```
public static int nreserved32(long struct)
```
    Unsafe version of reserved32().
  - nreserved32_2
```
public static int nreserved32_2(long struct)
```
    Unsafe version of reserved32_2().
  - ntotalLen
```
public static long ntotalLen(long struct)
```
    Unsafe version of totalLen().
  - nseed
```
public static long nseed(long struct)
```
    Unsafe version of seed().
  - nreserved64
```
public static long nreserved64(long struct)
```
    Unsafe version of reserved64().
  - nsecret
```
public static java.nio.ByteBuffer nsecret(long struct,
                                          int capacity)
```
    Unsafe version of secret.

Class XXH3State

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

ACC

CUSTOMSECRET

BUFFER

BUFFEREDSIZE

NBSTRIPESPERBLOCK

NBSTRIPESSOFAR

SECRETLIMIT

RESERVED32

RESERVED32_2

TOTALLEN

SEED

RESERVED64

SECRET

Constructor Detail

XXH3State

Method Detail

sizeof

acc

acc

customSecret

customSecret

buffer

buffer

bufferedSize

nbStripesPerBlock

nbStripesSoFar

secretLimit

reserved32

reserved32_2

totalLen

seed

reserved64

secret

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nacc

nacc

ncustomSecret

ncustomSecret

nbuffer

nbuffer

nbufferedSize

nnbStripesPerBlock

nnbStripesSoFar

nsecretLimit

nreserved32

nreserved32_2

ntotalLen

nseed