org.lwjgl.util.zstd.ZDICTParams 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.
The newest version!
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.util.zstd;
import org.jspecify.annotations.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Layout
*
*
* struct ZDICT_params_t {
* int {@link #compressionLevel};
* unsigned {@link #notificationLevel};
* unsigned {@link #dictID};
* }
*/
@NativeType("struct ZDICT_params_t")
public class ZDICTParams 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
COMPRESSIONLEVEL,
NOTIFICATIONLEVEL,
DICTID;
static {
Layout layout = __struct(
__member(4),
__member(4),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
COMPRESSIONLEVEL = layout.offsetof(0);
NOTIFICATIONLEVEL = layout.offsetof(1);
DICTID = layout.offsetof(2);
}
protected ZDICTParams(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected ZDICTParams create(long address, @Nullable ByteBuffer container) {
return new ZDICTParams(address, container);
}
/**
* Creates a {@code ZDICTParams} 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 ZDICTParams(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** optimize for a specific zstd compression level; 0 means default */
public int compressionLevel() { return ncompressionLevel(address()); }
/** write log to {@code stderr}; 0 = none (default); 1 = errors; 2 = progression; 3 = details; 4 = debug; */
@NativeType("unsigned")
public int notificationLevel() { return nnotificationLevel(address()); }
/**
* force {@code dictID} value; 0 means auto mode (32-bits random value).
*
* NOTE: The zstd format reserves some dictionary IDs for future use. You may use them in private settings, but be warned that they may be used by zstd in
* a public dictionary registry in the future. These dictionary IDs are:
*
*
* - low range : ≤ 32767
* - high range : ≥ (2^31)
*/
@NativeType("unsigned")
public int dictID() { return ndictID(address()); }
/** Sets the specified value to the {@link #compressionLevel} field. */
public ZDICTParams compressionLevel(int value) { ncompressionLevel(address(), value); return this; }
/** Sets the specified value to the {@link #notificationLevel} field. */
public ZDICTParams notificationLevel(@NativeType("unsigned") int value) { nnotificationLevel(address(), value); return this; }
/** Sets the specified value to the {@link #dictID} field. */
public ZDICTParams dictID(@NativeType("unsigned") int value) { ndictID(address(), value); return this; }
/** Initializes this struct with the specified values. */
public ZDICTParams set(
int compressionLevel,
int notificationLevel,
int dictID
) {
compressionLevel(compressionLevel);
notificationLevel(notificationLevel);
dictID(dictID);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public ZDICTParams set(ZDICTParams src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code ZDICTParams} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static ZDICTParams malloc() {
return new ZDICTParams(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code ZDICTParams} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static ZDICTParams calloc() {
return new ZDICTParams(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code ZDICTParams} instance allocated with {@link BufferUtils}. */
public static ZDICTParams create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new ZDICTParams(memAddress(container), container);
}
/** Returns a new {@code ZDICTParams} instance for the specified memory address. */
public static ZDICTParams create(long address) {
return new ZDICTParams(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable ZDICTParams createSafe(long address) {
return address == NULL ? null : new ZDICTParams(address, null);
}
/**
* Returns a new {@link ZDICTParams.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static ZDICTParams.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link ZDICTParams.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static ZDICTParams.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link ZDICTParams.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static ZDICTParams.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link ZDICTParams.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static ZDICTParams.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}. */
public static ZDICTParams.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
// -----------------------------------
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static ZDICTParams mallocStack() { return malloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static ZDICTParams callocStack() { return calloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static ZDICTParams mallocStack(MemoryStack stack) { return malloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static ZDICTParams callocStack(MemoryStack stack) { return calloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static ZDICTParams.Buffer mallocStack(int capacity) { return malloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static ZDICTParams.Buffer callocStack(int capacity) { return calloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static ZDICTParams.Buffer mallocStack(int capacity, MemoryStack stack) { return malloc(capacity, stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static ZDICTParams.Buffer callocStack(int capacity, MemoryStack stack) { return calloc(capacity, stack); }
/**
* Returns a new {@code ZDICTParams} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static ZDICTParams malloc(MemoryStack stack) {
return new ZDICTParams(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code ZDICTParams} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static ZDICTParams calloc(MemoryStack stack) {
return new ZDICTParams(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link ZDICTParams.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static ZDICTParams.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link ZDICTParams.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 ZDICTParams.Buffer calloc(int capacity, MemoryStack stack) {
return new Buffer(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #compressionLevel}. */
public static int ncompressionLevel(long struct) { return memGetInt(struct + ZDICTParams.COMPRESSIONLEVEL); }
/** Unsafe version of {@link #notificationLevel}. */
public static int nnotificationLevel(long struct) { return memGetInt(struct + ZDICTParams.NOTIFICATIONLEVEL); }
/** Unsafe version of {@link #dictID}. */
public static int ndictID(long struct) { return memGetInt(struct + ZDICTParams.DICTID); }
/** Unsafe version of {@link #compressionLevel(int) compressionLevel}. */
public static void ncompressionLevel(long struct, int value) { memPutInt(struct + ZDICTParams.COMPRESSIONLEVEL, value); }
/** Unsafe version of {@link #notificationLevel(int) notificationLevel}. */
public static void nnotificationLevel(long struct, int value) { memPutInt(struct + ZDICTParams.NOTIFICATIONLEVEL, value); }
/** Unsafe version of {@link #dictID(int) dictID}. */
public static void ndictID(long struct, int value) { memPutInt(struct + ZDICTParams.DICTID, value); }
// -----------------------------------
/** An array of {@link ZDICTParams} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final ZDICTParams ELEMENT_FACTORY = ZDICTParams.create(-1L);
/**
* Creates a new {@code ZDICTParams.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 ZDICTParams#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 create(long address, @Nullable ByteBuffer container, int mark, int position, int limit, int capacity) {
return new Buffer(address, container, mark, position, limit, capacity);
}
@Override
protected ZDICTParams getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link ZDICTParams#compressionLevel} field. */
public int compressionLevel() { return ZDICTParams.ncompressionLevel(address()); }
/** @return the value of the {@link ZDICTParams#notificationLevel} field. */
@NativeType("unsigned")
public int notificationLevel() { return ZDICTParams.nnotificationLevel(address()); }
/** @return the value of the {@link ZDICTParams#dictID} field. */
@NativeType("unsigned")
public int dictID() { return ZDICTParams.ndictID(address()); }
/** Sets the specified value to the {@link ZDICTParams#compressionLevel} field. */
public ZDICTParams.Buffer compressionLevel(int value) { ZDICTParams.ncompressionLevel(address(), value); return this; }
/** Sets the specified value to the {@link ZDICTParams#notificationLevel} field. */
public ZDICTParams.Buffer notificationLevel(@NativeType("unsigned") int value) { ZDICTParams.nnotificationLevel(address(), value); return this; }
/** Sets the specified value to the {@link ZDICTParams#dictID} field. */
public ZDICTParams.Buffer dictID(@NativeType("unsigned") int value) { ZDICTParams.ndictID(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy