Top Description Inners Fields Constructors Methods
org.lwjgl.util.zstd

public Class ZSTDBounds

extends Struct<ZSTDBounds>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct ZSTD_bounds
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
ZSTDBounds.Buffer

An array of ZSTDBounds structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ERROR

The struct member offsets.

public static final int
LOWERBOUND

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
UPPERBOUND

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
ZSTDBounds(long address, ByteBuffer container)

public
ZSTDBounds(ByteBuffer container)

Creates a ZSTDBounds instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static ZSTDBounds
calloc()

Returns a new ZSTDBounds instance allocated with memCalloc.

public static ZSTDBounds.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new ZSTDBounds.Buffer instance allocated with memCalloc.

public static ZSTDBounds
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static ZSTDBounds.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static ZSTDBounds
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDBounds
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDBounds.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDBounds.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected ZSTDBounds
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static ZSTDBounds
create()

Returns a new ZSTDBounds instance allocated with BufferUtils.

public static ZSTDBounds
create(long address)

Returns a new ZSTDBounds instance for the specified memory address.

public static ZSTDBounds.Buffer
create(int
the buffer capacity
capacity
)

Returns a new ZSTDBounds.Buffer instance allocated with BufferUtils.

public static ZSTDBounds.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a ZSTDBounds.Buffer instance at the specified memory.

public static ZSTDBounds
createSafe(long address)

Like create, but returns null if address is NULL.

public static ZSTDBounds.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public long

Returns:

the value of the error field.
error
()

public int

Returns:

the value of the lowerBound field.
lowerBound
()

public static ZSTDBounds
malloc()

Returns a new ZSTDBounds instance allocated with memAlloc.

public static ZSTDBounds.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new ZSTDBounds.Buffer instance allocated with memAlloc.

public static ZSTDBounds
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new ZSTDBounds instance allocated on the specified MemoryStack.

public static ZSTDBounds.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static ZSTDBounds
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDBounds
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDBounds.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static ZSTDBounds.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static long
nerror(long struct)

Unsafe version of error.

public static int
nlowerBound(long struct)

Unsafe version of lowerBound.

public static int
nupperBound(long struct)

Unsafe version of upperBound.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int

Returns:

the value of the upperBound field.
upperBound
()

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

ERRORback to summary
public static final int ERROR

The struct member offsets.

LOWERBOUNDback to summary
public static final int LOWERBOUND

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

UPPERBOUNDback to summary
public static final int UPPERBOUND

The struct member offsets.

Constructor Detail

ZSTDBoundsback to summary
protected ZSTDBounds(long address, ByteBuffer container)
ZSTDBoundsback to summary
public ZSTDBounds(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

callocback to summary
public static ZSTDBounds calloc()

Returns a new ZSTDBounds instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static ZSTDBounds.Buffer calloc(int capacity)

Returns a new ZSTDBounds.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static ZSTDBounds calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static ZSTDBounds.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static ZSTDBounds callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static ZSTDBounds callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static ZSTDBounds.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static ZSTDBounds.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected ZSTDBounds create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static ZSTDBounds create()

Returns a new ZSTDBounds instance allocated with BufferUtils.

createback to summary
public static ZSTDBounds create(long address)

Returns a new ZSTDBounds instance for the specified memory address.

createback to summary
public static ZSTDBounds.Buffer create(int capacity)

Returns a new ZSTDBounds.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static ZSTDBounds.Buffer create(long address, int capacity)

Create a ZSTDBounds.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static ZSTDBounds createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static ZSTDBounds.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
errorback to summary
public long error()
Returns:long

the value of the error field.

Annotations
@NativeType:size_t
lowerBoundback to summary
public int lowerBound()
Returns:int

the value of the lowerBound field.

mallocback to summary
public static ZSTDBounds malloc()

Returns a new ZSTDBounds instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static ZSTDBounds.Buffer malloc(int capacity)

Returns a new ZSTDBounds.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static ZSTDBounds malloc(MemoryStack stack)

Returns a new ZSTDBounds instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static ZSTDBounds.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static ZSTDBounds mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static ZSTDBounds mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static ZSTDBounds.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static ZSTDBounds.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nerrorback to summary
public static long nerror(long struct)

Unsafe version of error.

nlowerBoundback to summary
public static int nlowerBound(long struct)

Unsafe version of lowerBound.

nupperBoundback to summary
public static int nupperBound(long struct)

Unsafe version of upperBound.

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
upperBoundback to summary
public int upperBound()
Returns:int

the value of the upperBound field.

org.lwjgl.util.zstd back to summary

public Class ZSTDBounds.Buffer

extends StructBuffer<ZSTDBounds, ZSTDBounds.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of ZSTDBounds structs.

Field Summary

Modifier and TypeField and Description
private static final ZSTDBounds

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new ZSTDBounds.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the error field.
error
()

protected ZSTDBounds
public int

Returns:

the value of the lowerBound field.
lowerBound
()

protected ZSTDBounds.Buffer
public int

Returns:

the value of the upperBound field.
upperBound
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final ZSTDBounds ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new ZSTDBounds.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by ZSTDBounds#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

errorback to summary
public long error()
Returns:long

the value of the error field.

Annotations
@NativeType:size_t
getElementFactoryback to summary
protected ZSTDBounds getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
lowerBoundback to summary
public int lowerBound()
Returns:int

the value of the lowerBound field.

selfback to summary
protected ZSTDBounds.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
upperBoundback to summary
public int upperBound()
Returns:int

the value of the upperBound field.