org.lwjgl.util.zstd.ZSTDOutBuffer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-zstd Show documentation
Show all versions of lwjgl-zstd Show documentation
A fast lossless compression algorithm, targeting real-time compression scenarios at zlib-level and better compression ratios.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.util.zstd;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Member documentation
*
*
* - {@code dst} – start of output buffer
* - {@code size} – size of output buffer
* - {@code pos} – position where writing stopped. Will be updated. Necessarily {@code 0 <= pos <= size}
*
*
* Layout
*
*
* struct ZSTD_outBuffer {
* void * dst;
* size_t size;
* size_t pos;
* }
*/
@NativeType("struct ZSTD_outBuffer")
public class ZSTDOutBuffer extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
DST,
SIZE,
POS;
static {
Layout layout = __struct(
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
DST = layout.offsetof(0);
SIZE = layout.offsetof(1);
POS = layout.offsetof(2);
}
ZSTDOutBuffer(long address, @Nullable ByteBuffer container) {
super(address, container);
}
/**
* Creates a {@link ZSTDOutBuffer} instance at the current position of the specified {@link 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.
*/
public ZSTDOutBuffer(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns a {@link ByteBuffer} view of the data pointed to by the {@code dst} field. */
@NativeType("void *")
public ByteBuffer dst() { return ndst(address()); }
/** Returns the value of the {@code size} field. */
@NativeType("size_t")
public long size() { return nsize(address()); }
/** Returns the value of the {@code pos} field. */
@NativeType("size_t")
public long pos() { return npos(address()); }
/** Sets the address of the specified {@link ByteBuffer} to the {@code dst} field. */
public ZSTDOutBuffer dst(@NativeType("void *") ByteBuffer value) { ndst(address(), value); return this; }
/** Sets the specified value to the {@code pos} field. */
public ZSTDOutBuffer pos(@NativeType("size_t") long value) { npos(address(), value); return this; }
/** Initializes this struct with the specified values. */
public ZSTDOutBuffer set(
ByteBuffer dst,
long pos
) {
dst(dst);
pos(pos);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public ZSTDOutBuffer set(ZSTDOutBuffer src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link ZSTDOutBuffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static ZSTDOutBuffer malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link ZSTDOutBuffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static ZSTDOutBuffer calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link ZSTDOutBuffer} instance allocated with {@link BufferUtils}. */
public static ZSTDOutBuffer create() {
return new ZSTDOutBuffer(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link ZSTDOutBuffer} instance for the specified memory address. */
public static ZSTDOutBuffer create(long address) {
return new ZSTDOutBuffer(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static ZSTDOutBuffer createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link ZSTDOutBuffer.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static ZSTDOutBuffer.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link ZSTDOutBuffer.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static ZSTDOutBuffer.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link ZSTDOutBuffer.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static ZSTDOutBuffer.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link ZSTDOutBuffer.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static ZSTDOutBuffer.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static ZSTDOutBuffer.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link ZSTDOutBuffer} instance allocated on the thread-local {@link MemoryStack}. */
public static ZSTDOutBuffer mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link ZSTDOutBuffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static ZSTDOutBuffer callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link ZSTDOutBuffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static ZSTDOutBuffer mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link ZSTDOutBuffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static ZSTDOutBuffer callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link ZSTDOutBuffer.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static ZSTDOutBuffer.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link ZSTDOutBuffer.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static ZSTDOutBuffer.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link ZSTDOutBuffer.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static ZSTDOutBuffer.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link ZSTDOutBuffer.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static ZSTDOutBuffer.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #dst() dst}. */
public static ByteBuffer ndst(long struct) { return memByteBuffer(memGetAddress(struct + ZSTDOutBuffer.DST), (int)nsize(struct)); }
/** Unsafe version of {@link #size}. */
public static long nsize(long struct) { return memGetAddress(struct + ZSTDOutBuffer.SIZE); }
/** Unsafe version of {@link #pos}. */
public static long npos(long struct) { return memGetAddress(struct + ZSTDOutBuffer.POS); }
/** Unsafe version of {@link #dst(ByteBuffer) dst}. */
public static void ndst(long struct, ByteBuffer value) { memPutAddress(struct + ZSTDOutBuffer.DST, memAddress(value)); nsize(struct, value.remaining()); }
/** Sets the specified value to the {@code size} field of the specified {@code struct}. */
public static void nsize(long struct, long value) { memPutAddress(struct + ZSTDOutBuffer.SIZE, value); }
/** Unsafe version of {@link #pos(long) pos}. */
public static void npos(long struct, long value) { memPutAddress(struct + ZSTDOutBuffer.POS, value); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
check(memGetAddress(struct + ZSTDOutBuffer.DST));
}
/**
* Calls {@link #validate(long)} for each struct contained in the specified struct array.
*
* @param array the struct array to validate
* @param count the number of structs in {@code array}
*/
public static void validate(long array, int count) {
for (int i = 0; i < count; i++) {
validate(array + i * SIZEOF);
}
}
// -----------------------------------
/** An array of {@link ZSTDOutBuffer} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link ZSTDOutBuffer.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 {@link ZSTDOutBuffer#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected Buffer newBufferInstance(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected ZSTDOutBuffer newInstance(long address) {
return new ZSTDOutBuffer(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns a {@link ByteBuffer} view of the data pointed to by the {@code dst} field. */
@NativeType("void *")
public ByteBuffer dst() { return ZSTDOutBuffer.ndst(address()); }
/** Returns the value of the {@code size} field. */
@NativeType("size_t")
public long size() { return ZSTDOutBuffer.nsize(address()); }
/** Returns the value of the {@code pos} field. */
@NativeType("size_t")
public long pos() { return ZSTDOutBuffer.npos(address()); }
/** Sets the address of the specified {@link ByteBuffer} to the {@code dst} field. */
public ZSTDOutBuffer.Buffer dst(@NativeType("void *") ByteBuffer value) { ZSTDOutBuffer.ndst(address(), value); return this; }
/** Sets the specified value to the {@code pos} field. */
public ZSTDOutBuffer.Buffer pos(@NativeType("size_t") long value) { ZSTDOutBuffer.npos(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy