org.lwjgl.util.zstd.ZSTDInBuffer

All Implemented Interfaces:: AutoCloseable, NativeResource, Pointer

public class ZSTDInBuffer extends Struct<ZSTDInBuffer> implements NativeResource


 struct ZSTD_inBuffer {
     void const * src;
     size_t size;
     size_t pos;
 }

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

ZSTDInBuffer.Buffer

An array of ZSTDInBuffer structs.

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

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

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

POS

The struct member offsets.

static final int

SIZE

The struct member offsets.

static final int

SIZEOF

The struct size in bytes.

static final int

SRC

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

ZSTDInBuffer(ByteBuffer container)

Creates a ZSTDInBuffer instance at the current position of the specified ByteBuffer container.
Method Summary

Modifier and Type

Method

Description

static ZSTDInBuffer

calloc()

Returns a new ZSTDInBuffer instance allocated with memCalloc.

static ZSTDInBuffer.Buffer

calloc(int capacity)

Returns a new ZSTDInBuffer.Buffer instance allocated with memCalloc.

static ZSTDInBuffer.Buffer

calloc(int capacity, MemoryStack stack)

Returns a new ZSTDInBuffer.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

static ZSTDInBuffer

calloc(MemoryStack stack)

Returns a new ZSTDInBuffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

static ZSTDInBuffer

callocStack()

Deprecated.

static ZSTDInBuffer.Buffer

callocStack(int capacity)

Deprecated.

static ZSTDInBuffer.Buffer

callocStack(int capacity, MemoryStack stack)

Deprecated.

static ZSTDInBuffer

callocStack(MemoryStack stack)

Deprecated.

static ZSTDInBuffer

create()

Returns a new ZSTDInBuffer instance allocated with BufferUtils.

static ZSTDInBuffer.Buffer

create(int capacity)

Returns a new ZSTDInBuffer.Buffer instance allocated with BufferUtils.

static ZSTDInBuffer

create(long address)

Returns a new ZSTDInBuffer instance for the specified memory address.

static ZSTDInBuffer.Buffer

create(long address, int capacity)

Create a ZSTDInBuffer.Buffer instance at the specified memory.

static @Nullable ZSTDInBuffer

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable ZSTDInBuffer.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

static ZSTDInBuffer

malloc()

Returns a new ZSTDInBuffer instance allocated with memAlloc.

static ZSTDInBuffer.Buffer

malloc(int capacity)

Returns a new ZSTDInBuffer.Buffer instance allocated with memAlloc.

static ZSTDInBuffer.Buffer

malloc(int capacity, MemoryStack stack)

Returns a new ZSTDInBuffer.Buffer instance allocated on the specified MemoryStack.

static ZSTDInBuffer

malloc(MemoryStack stack)

Returns a new ZSTDInBuffer instance allocated on the specified MemoryStack.

static ZSTDInBuffer

mallocStack()

Deprecated.

static ZSTDInBuffer.Buffer

mallocStack(int capacity)

Deprecated.

static ZSTDInBuffer.Buffer

mallocStack(int capacity, MemoryStack stack)

Deprecated.

static ZSTDInBuffer

mallocStack(MemoryStack stack)

Deprecated.

static long

npos(long struct)

Unsafe version of pos().

static void

npos(long struct, long value)

Unsafe version of pos.

static long

nsize(long struct)

Unsafe version of size().

static void

nsize(long struct, long value)

Sets the specified value to the size field of the specified struct.

static ByteBuffer

nsrc(long struct)

Unsafe version of src.

static void

nsrc(long struct, ByteBuffer value)

Unsafe version of src.

long

pos()

ZSTDInBuffer

pos(long value)

Sets the specified value to the pos field.

ZSTDInBuffer

set(ByteBuffer src, long pos)

Initializes this struct with the specified values.

ZSTDInBuffer

set(ZSTDInBuffer src)

Copies the specified struct data to this struct.

long

size()

int

sizeof()

Returns sizeof(struct).

ByteBuffer

src()

ZSTDInBuffer

src(ByteBuffer value)

Sets the address of the specified ByteBuffer to the src field.

static void

validate(long struct)

Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validate

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 Details
- SIZEOF
  
  public static final int SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  public static final int ALIGNOF
  
  The struct alignment in bytes.
- SRC
  
  public static final int SRC
  
  The struct member offsets.
- SIZE
  
  public static final int SIZE
  
  The struct member offsets.
- POS
  
  public static final int POS
  
  The struct member offsets.
Constructor Details
- ZSTDInBuffer
  
  public ZSTDInBuffer(ByteBuffer container)
  
  Creates a ZSTDInBuffer 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 Details
- sizeof
  
  public int sizeof()
  
  Description copied from class: Struct
  
  Returns sizeof(struct).
  
  Specified by:
  
  sizeof in class Struct<ZSTDInBuffer>
- src
  
  public ByteBuffer src()
  
  Returns:
  
  a ByteBuffer view of the data pointed to by the src field.
- size
  
  public long size()
  
  Returns:
  
  the value of the size field.
- pos
  
  public long pos()
  
  Returns:
  
  the value of the pos field.
- src
  
  public ZSTDInBuffer src(ByteBuffer value)
  
  Sets the address of the specified ByteBuffer to the src field.
- pos
  
  public ZSTDInBuffer pos(long value)
  
  Sets the specified value to the pos field.
- set
  
  public ZSTDInBuffer set(ByteBuffer src, long pos)
  
  Initializes this struct with the specified values.
- set
  
  public ZSTDInBuffer set(ZSTDInBuffer src)
  
  Copies the specified struct data to this struct.
  
  Parameters:
  
  src - the source struct
  
  Returns:
  
  this struct
- malloc
  
  public static ZSTDInBuffer malloc()
  
  Returns a new ZSTDInBuffer instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static ZSTDInBuffer calloc()
  
  Returns a new ZSTDInBuffer instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static ZSTDInBuffer create()
  
  Returns a new ZSTDInBuffer instance allocated with BufferUtils.
- create
  
  public static ZSTDInBuffer create(long address)
  
  Returns a new ZSTDInBuffer instance for the specified memory address.
- createSafe
  
  public static @Nullable ZSTDInBuffer createSafe(long address)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static ZSTDInBuffer.Buffer malloc(int capacity)
  
  Returns a new ZSTDInBuffer.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- calloc
  
  public static ZSTDInBuffer.Buffer calloc(int capacity)
  
  Returns a new ZSTDInBuffer.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static ZSTDInBuffer.Buffer create(int capacity)
  
  Returns a new ZSTDInBuffer.Buffer instance allocated with BufferUtils.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static ZSTDInBuffer.Buffer create(long address, int capacity)
  
  Create a ZSTDInBuffer.Buffer instance at the specified memory.
  
  Parameters:
  
  address - the memory address
  
  capacity - the buffer capacity
- createSafe
  
  public static @Nullable ZSTDInBuffer.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- mallocStack
  
  @Deprecated public static ZSTDInBuffer mallocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static ZSTDInBuffer callocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static ZSTDInBuffer mallocStack(MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static ZSTDInBuffer callocStack(MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static ZSTDInBuffer.Buffer mallocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static ZSTDInBuffer.Buffer callocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- mallocStack
  
  @Deprecated public static ZSTDInBuffer.Buffer mallocStack(int capacity, MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static ZSTDInBuffer.Buffer callocStack(int capacity, MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- malloc
  
  public static ZSTDInBuffer malloc(MemoryStack stack)
  
  Returns a new ZSTDInBuffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static ZSTDInBuffer calloc(MemoryStack stack)
  
  Returns a new ZSTDInBuffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  stack - the stack from which to allocate
- malloc
  
  public static ZSTDInBuffer.Buffer malloc(int capacity, MemoryStack stack)
  
  Returns a new ZSTDInBuffer.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static ZSTDInBuffer.Buffer calloc(int capacity, MemoryStack stack)
  
  Returns a new ZSTDInBuffer.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- nsrc
  
  public static ByteBuffer nsrc(long struct)
  
  Unsafe version of src.
- nsize
  
  public static long nsize(long struct)
  
  Unsafe version of size().
- npos
  
  public static long npos(long struct)
  
  Unsafe version of pos().
- nsrc
  
  public static void nsrc(long struct, ByteBuffer value)
  
  Unsafe version of src.
- nsize
  
  public static void nsize(long struct, long value)
  
  Sets the specified value to the size field of the specified struct.
- npos
  
  public static void npos(long struct, long value)
  
  Unsafe version of pos.
- validate
  
  public static void validate(long struct)
  
  Validates pointer members that should not be NULL.
  
  Parameters:
  
  struct - the struct to validate

Class ZSTDInBuffer

Nested Class Summary

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

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 Details

SIZEOF

ALIGNOF

SRC

SIZE

POS

Constructor Details

ZSTDInBuffer

Method Details

sizeof

src

size

pos

src

pos

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nsrc

nsize

npos

nsrc

nsize

npos

validate