ZSTDBounds (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.util.zstd.ZSTDBounds

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

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

Layout


 struct ZSTD_bounds {
     size_t error;
     int lowerBound;
     int upperBound;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ERROR` The struct member offsets.
`static int`	`LOWERBOUND` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`UPPERBOUND` 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

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

Constructors
Constructor and Description
`ZSTDBounds(java.nio.ByteBuffer container)` Creates a `ZSTDBounds` 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 ZSTDBounds`	`calloc()` Returns a new `ZSTDBounds` instance allocated with `memCalloc`.
`static ZSTDBounds.Buffer`	`calloc(int capacity)` Returns a new `ZSTDBounds.Buffer` instance allocated with `memCalloc`.
`static ZSTDBounds`	`callocStack()` Returns a new `ZSTDBounds` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZSTDBounds.Buffer`	`callocStack(int capacity)` Returns a new `ZSTDBounds.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZSTDBounds.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDBounds.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static ZSTDBounds`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDBounds` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static ZSTDBounds`	`create()` Returns a new `ZSTDBounds` instance allocated with `BufferUtils`.
`static ZSTDBounds.Buffer`	`create(int capacity)` Returns a new `ZSTDBounds.Buffer` instance allocated with `BufferUtils`.
`static ZSTDBounds`	`create(long address)` Returns a new `ZSTDBounds` instance for the specified memory address.
`static ZSTDBounds.Buffer`	`create(long address, int capacity)` Create a `ZSTDBounds.Buffer` instance at the specified memory.
`static ZSTDBounds`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static ZSTDBounds.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`long`	`error()` Returns the value of the `error` field.
`int`	`lowerBound()` Returns the value of the `lowerBound` field.
`static ZSTDBounds`	`malloc()` Returns a new `ZSTDBounds` instance allocated with `memAlloc`.
`static ZSTDBounds.Buffer`	`malloc(int capacity)` Returns a new `ZSTDBounds.Buffer` instance allocated with `memAlloc`.
`static ZSTDBounds`	`mallocStack()` Returns a new `ZSTDBounds` instance allocated on the thread-local `MemoryStack`.
`static ZSTDBounds.Buffer`	`mallocStack(int capacity)` Returns a new `ZSTDBounds.Buffer` instance allocated on the thread-local `MemoryStack`.
`static ZSTDBounds.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDBounds.Buffer` instance allocated on the specified `MemoryStack`.
`static ZSTDBounds`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDBounds` instance allocated on the specified `MemoryStack`.
`static long`	`nerror(long struct)` Unsafe version of `error()`.
`static int`	`nlowerBound(long struct)` Unsafe version of `lowerBound()`.
`static int`	`nupperBound(long struct)` Unsafe version of `upperBound()`.
`int`	`sizeof()`
`int`	`upperBound()` Returns the value of the `upperBound` 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.
  - ERROR
```
public static final int ERROR
```
    The struct member offsets.
  - LOWERBOUND
```
public static final int LOWERBOUND
```
    The struct member offsets.
  - UPPERBOUND
```
public static final int UPPERBOUND
```
    The struct member offsets.
- Constructor Detail
  - ZSTDBounds
```
public ZSTDBounds(java.nio.ByteBuffer container)
```
    Creates a ZSTDBounds 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
  - error
```
public long error()
```
    Returns the value of the error field.
  - lowerBound
```
public int lowerBound()
```
    Returns the value of the lowerBound field.
  - upperBound
```
public int upperBound()
```
    Returns the value of the upperBound field.
  - malloc
```
public static ZSTDBounds malloc()
```
    Returns a new ZSTDBounds instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static ZSTDBounds calloc()
```
    Returns a new ZSTDBounds instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static ZSTDBounds create()
```
    Returns a new ZSTDBounds instance allocated with BufferUtils.
  - create
```
public static ZSTDBounds create(long address)
```
    Returns a new ZSTDBounds instance for the specified memory address.
  - createSafe
```
@Nullable
public static ZSTDBounds createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static ZSTDBounds.Buffer malloc(int capacity)
```
    Returns a new ZSTDBounds.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static ZSTDBounds.Buffer calloc(int capacity)
```
    Returns a new ZSTDBounds.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ZSTDBounds.Buffer create(int capacity)
```
    Returns a new ZSTDBounds.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ZSTDBounds.Buffer create(long address,
                                       int capacity)
```
    Create a ZSTDBounds.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static ZSTDBounds.Buffer createSafe(long address,
                                                     int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static ZSTDBounds mallocStack()
```
    Returns a new ZSTDBounds instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static ZSTDBounds callocStack()
```
    Returns a new ZSTDBounds instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static ZSTDBounds mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDBounds instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static ZSTDBounds callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDBounds instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static ZSTDBounds.Buffer mallocStack(int capacity)
```
    Returns a new ZSTDBounds.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static ZSTDBounds.Buffer callocStack(int capacity)
```
    Returns a new ZSTDBounds.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static ZSTDBounds.Buffer mallocStack(int capacity,
                                            org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDBounds.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static ZSTDBounds.Buffer callocStack(int capacity,
                                            org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDBounds.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
  - nerror
```
public static long nerror(long struct)
```
    Unsafe version of error().
  - nlowerBound
```
public static int nlowerBound(long struct)
```
    Unsafe version of lowerBound().
  - nupperBound
```
public static int nupperBound(long struct)
```
    Unsafe version of upperBound().

Class ZSTDBounds

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

ERROR

LOWERBOUND

UPPERBOUND

Constructor Detail

ZSTDBounds

Method Detail

sizeof

error

lowerBound

upperBound

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nerror

nlowerBound

nupperBound