ZSTDCustomMem (LWJGL 3.2.4 SNAPSHOT

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

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

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

Layout


 struct ZSTD_customMem {
     ZSTD_allocFunction customAlloc;
     ZSTD_freeFunction customFree;
     void * opaque;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`CUSTOMALLOC` The struct member offsets.
`static int`	`CUSTOMFREE` The struct member offsets.
`static int`	`OPAQUE` 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

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`ZSTDCustomMem(java.nio.ByteBuffer container)` Creates a `ZSTDCustomMem` 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 ZSTDCustomMem`	`calloc()` Returns a new `ZSTDCustomMem` instance allocated with `memCalloc`.
`static ZSTDCustomMem.Buffer`	`calloc(int capacity)` Returns a new `ZSTDCustomMem.Buffer` instance allocated with `memCalloc`.
`static ZSTDCustomMem`	`callocStack()` Returns a new `ZSTDCustomMem` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZSTDCustomMem.Buffer`	`callocStack(int capacity)` Returns a new `ZSTDCustomMem.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZSTDCustomMem.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDCustomMem.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static ZSTDCustomMem`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDCustomMem` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static ZSTDCustomMem`	`create()` Returns a new `ZSTDCustomMem` instance allocated with `BufferUtils`.
`static ZSTDCustomMem.Buffer`	`create(int capacity)` Returns a new `ZSTDCustomMem.Buffer` instance allocated with `BufferUtils`.
`static ZSTDCustomMem`	`create(long address)` Returns a new `ZSTDCustomMem` instance for the specified memory address.
`static ZSTDCustomMem.Buffer`	`create(long address, int capacity)` Create a `ZSTDCustomMem.Buffer` instance at the specified memory.
`static ZSTDCustomMem`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static ZSTDCustomMem.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`ZSTDAllocFunction`	`customAlloc()` Returns the value of the `customAlloc` field.
`ZSTDCustomMem`	`customAlloc(ZSTDAllocFunctionI value)` Sets the specified value to the `customAlloc` field.
`ZSTDFreeFunction`	`customFree()` Returns the value of the `customFree` field.
`ZSTDCustomMem`	`customFree(ZSTDFreeFunctionI value)` Sets the specified value to the `customFree` field.
`static ZSTDCustomMem`	`malloc()` Returns a new `ZSTDCustomMem` instance allocated with `memAlloc`.
`static ZSTDCustomMem.Buffer`	`malloc(int capacity)` Returns a new `ZSTDCustomMem.Buffer` instance allocated with `memAlloc`.
`static ZSTDCustomMem`	`mallocStack()` Returns a new `ZSTDCustomMem` instance allocated on the thread-local `MemoryStack`.
`static ZSTDCustomMem.Buffer`	`mallocStack(int capacity)` Returns a new `ZSTDCustomMem.Buffer` instance allocated on the thread-local `MemoryStack`.
`static ZSTDCustomMem.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDCustomMem.Buffer` instance allocated on the specified `MemoryStack`.
`static ZSTDCustomMem`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDCustomMem` instance allocated on the specified `MemoryStack`.
`static ZSTDAllocFunction`	`ncustomAlloc(long struct)` Unsafe version of `customAlloc()`.
`static void`	`ncustomAlloc(long struct, ZSTDAllocFunctionI value)` Unsafe version of `customAlloc`.
`static ZSTDFreeFunction`	`ncustomFree(long struct)` Unsafe version of `customFree()`.
`static void`	`ncustomFree(long struct, ZSTDFreeFunctionI value)` Unsafe version of `customFree`.
`static long`	`nopaque(long struct)` Unsafe version of `opaque()`.
`static void`	`nopaque(long struct, long value)` Unsafe version of `opaque`.
`long`	`opaque()` Returns the value of the `opaque` field.
`ZSTDCustomMem`	`opaque(long value)` Sets the specified value to the `opaque` field.
`ZSTDCustomMem`	`set(ZSTDAllocFunctionI customAlloc, ZSTDFreeFunctionI customFree, long opaque)` Initializes this struct with the specified values.
`ZSTDCustomMem`	`set(ZSTDCustomMem src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

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.
  - CUSTOMALLOC
```
public static final int CUSTOMALLOC
```
    The struct member offsets.
  - CUSTOMFREE
```
public static final int CUSTOMFREE
```
    The struct member offsets.
  - OPAQUE
```
public static final int OPAQUE
```
    The struct member offsets.
- Constructor Detail
  - ZSTDCustomMem
```
public ZSTDCustomMem(java.nio.ByteBuffer container)
```
    Creates a ZSTDCustomMem 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
  - customAlloc
```
public ZSTDAllocFunction customAlloc()
```
    Returns the value of the customAlloc field.
  - customFree
```
public ZSTDFreeFunction customFree()
```
    Returns the value of the customFree field.
  - opaque
```
public long opaque()
```
    Returns the value of the opaque field.
  - customAlloc
```
public ZSTDCustomMem customAlloc(ZSTDAllocFunctionI value)
```
    Sets the specified value to the customAlloc field.
  - customFree
```
public ZSTDCustomMem customFree(ZSTDFreeFunctionI value)
```
    Sets the specified value to the customFree field.
  - opaque
```
public ZSTDCustomMem opaque(long value)
```
    Sets the specified value to the opaque field.
  - set
```
public ZSTDCustomMem set(ZSTDAllocFunctionI customAlloc,
                         ZSTDFreeFunctionI customFree,
                         long opaque)
```
    Initializes this struct with the specified values.
  - set
```
public ZSTDCustomMem set(ZSTDCustomMem src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static ZSTDCustomMem malloc()
```
    Returns a new ZSTDCustomMem instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static ZSTDCustomMem calloc()
```
    Returns a new ZSTDCustomMem instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static ZSTDCustomMem create()
```
    Returns a new ZSTDCustomMem instance allocated with BufferUtils.
  - create
```
public static ZSTDCustomMem create(long address)
```
    Returns a new ZSTDCustomMem instance for the specified memory address.
  - createSafe
```
@Nullable
public static ZSTDCustomMem createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static ZSTDCustomMem.Buffer malloc(int capacity)
```
    Returns a new ZSTDCustomMem.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static ZSTDCustomMem.Buffer calloc(int capacity)
```
    Returns a new ZSTDCustomMem.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ZSTDCustomMem.Buffer create(int capacity)
```
    Returns a new ZSTDCustomMem.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ZSTDCustomMem.Buffer create(long address,
                                          int capacity)
```
    Create a ZSTDCustomMem.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static ZSTDCustomMem.Buffer createSafe(long address,
                                                        int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static ZSTDCustomMem mallocStack()
```
    Returns a new ZSTDCustomMem instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static ZSTDCustomMem callocStack()
```
    Returns a new ZSTDCustomMem instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static ZSTDCustomMem mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDCustomMem instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static ZSTDCustomMem callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDCustomMem instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static ZSTDCustomMem.Buffer mallocStack(int capacity)
```
    Returns a new ZSTDCustomMem.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static ZSTDCustomMem.Buffer callocStack(int capacity)
```
    Returns a new ZSTDCustomMem.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static ZSTDCustomMem.Buffer mallocStack(int capacity,
                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDCustomMem.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static ZSTDCustomMem.Buffer callocStack(int capacity,
                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDCustomMem.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
  - ncustomAlloc
```
public static ZSTDAllocFunction ncustomAlloc(long struct)
```
    Unsafe version of customAlloc().
  - ncustomFree
```
public static ZSTDFreeFunction ncustomFree(long struct)
```
    Unsafe version of customFree().
  - nopaque
```
public static long nopaque(long struct)
```
    Unsafe version of opaque().
  - ncustomAlloc
```
public static void ncustomAlloc(long struct,
                                ZSTDAllocFunctionI value)
```
    Unsafe version of customAlloc.
  - ncustomFree
```
public static void ncustomFree(long struct,
                               ZSTDFreeFunctionI value)
```
    Unsafe version of customFree.
  - nopaque
```
public static void nopaque(long struct,
                           long value)
```
    Unsafe version of opaque.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class ZSTDCustomMem

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

CUSTOMALLOC

CUSTOMFREE

OPAQUE

Constructor Detail

ZSTDCustomMem

Method Detail

sizeof

customAlloc

customFree

opaque

customAlloc

customFree

opaque

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ncustomAlloc

ncustomFree

nopaque

ncustomAlloc

ncustomFree

nopaque

validate

validate