Package org.lwjgl.util.zstd
Class ZDICTParams
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.util.zstd.ZDICTParams
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class ZDICTParams extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceLayout
struct ZDICT_params_t { intcompressionLevel(); unsignednotificationLevel(); unsigneddictID(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classZDICTParams.BufferAn array ofZDICTParamsstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intCOMPRESSIONLEVEL
DICTID
NOTIFICATIONLEVELThe struct member offsets.static intSIZEOFThe struct size in bytes.
-
Constructor Summary
Constructors Constructor Description ZDICTParams(java.nio.ByteBuffer container)Creates aZDICTParamsinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static ZDICTParamscalloc()Returns a newZDICTParamsinstance allocated withmemCalloc.static ZDICTParams.Buffercalloc(int capacity)Returns a newZDICTParams.Bufferinstance allocated withmemCalloc.static ZDICTParams.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newZDICTParams.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static ZDICTParamscalloc(org.lwjgl.system.MemoryStack stack)Returns a newZDICTParamsinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static ZDICTParamscallocStack()Deprecated.static ZDICTParams.BuffercallocStack(int capacity)Deprecated.static ZDICTParams.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static ZDICTParamscallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.intcompressionLevel()optimize for a specific zstd compression level; 0 means defaultZDICTParamscompressionLevel(int value)Sets the specified value to thecompressionLevel()field.static ZDICTParamscreate()Returns a newZDICTParamsinstance allocated withBufferUtils.static ZDICTParams.Buffercreate(int capacity)Returns a newZDICTParams.Bufferinstance allocated withBufferUtils.static ZDICTParamscreate(long address)Returns a newZDICTParamsinstance for the specified memory address.static ZDICTParams.Buffercreate(long address, int capacity)Create aZDICTParams.Bufferinstance at the specified memory.static ZDICTParamscreateSafe(long address)static ZDICTParams.BuffercreateSafe(long address, int capacity)intdictID()forcedictIDvalue; 0 means auto mode (32-bits random value).ZDICTParamsdictID(int value)Sets the specified value to thedictID()field.static ZDICTParamsmalloc()Returns a newZDICTParamsinstance allocated withmemAlloc.static ZDICTParams.Buffermalloc(int capacity)Returns a newZDICTParams.Bufferinstance allocated withmemAlloc.static ZDICTParams.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newZDICTParams.Bufferinstance allocated on the specifiedMemoryStack.static ZDICTParamsmalloc(org.lwjgl.system.MemoryStack stack)Returns a newZDICTParamsinstance allocated on the specifiedMemoryStack.static ZDICTParamsmallocStack()Deprecated.static ZDICTParams.BuffermallocStack(int capacity)Deprecated.static ZDICTParams.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static ZDICTParamsmallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static intncompressionLevel(long struct)Unsafe version ofcompressionLevel().static voidncompressionLevel(long struct, int value)Unsafe version ofcompressionLevel.static intndictID(long struct)Unsafe version ofdictID().static voidndictID(long struct, int value)Unsafe version ofdictID.static intnnotificationLevel(long struct)Unsafe version ofnotificationLevel().static voidnnotificationLevel(long struct, int value)Unsafe version ofnotificationLevel.intnotificationLevel()write log tostderr; 0 = none (default); 1 = errors; 2 = progression; 3 = details; 4 = debug;ZDICTParamsnotificationLevel(int value)Sets the specified value to thenotificationLevel()field.ZDICTParamsset(int compressionLevel, int notificationLevel, int dictID)Initializes this struct with the specified values.ZDICTParamsset(ZDICTParams src)Copies the specified struct data to this struct.intsizeof()
-
-
-
Constructor Detail
-
ZDICTParams
public ZDICTParams(java.nio.ByteBuffer container)
Creates aZDICTParamsinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
compressionLevel
public int compressionLevel()
optimize for a specific zstd compression level; 0 means default
-
notificationLevel
public int notificationLevel()
write log tostderr; 0 = none (default); 1 = errors; 2 = progression; 3 = details; 4 = debug;
-
dictID
public int dictID()
forcedictIDvalue; 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)
-
compressionLevel
public ZDICTParams compressionLevel(int value)
Sets the specified value to thecompressionLevel()field.
-
notificationLevel
public ZDICTParams notificationLevel(int value)
Sets the specified value to thenotificationLevel()field.
-
dictID
public ZDICTParams dictID(int value)
Sets the specified value to thedictID()field.
-
set
public ZDICTParams set(int compressionLevel, int notificationLevel, int dictID)
Initializes this struct with the specified values.
-
set
public ZDICTParams set(ZDICTParams src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static ZDICTParams malloc()
Returns a newZDICTParamsinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static ZDICTParams calloc()
Returns a newZDICTParamsinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static ZDICTParams create()
Returns a newZDICTParamsinstance allocated withBufferUtils.
-
create
public static ZDICTParams create(long address)
Returns a newZDICTParamsinstance for the specified memory address.
-
createSafe
@Nullable public static ZDICTParams createSafe(long address)
-
malloc
public static ZDICTParams.Buffer malloc(int capacity)
Returns a newZDICTParams.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static ZDICTParams.Buffer calloc(int capacity)
Returns a newZDICTParams.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static ZDICTParams.Buffer create(int capacity)
Returns a newZDICTParams.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static ZDICTParams.Buffer create(long address, int capacity)
Create aZDICTParams.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static ZDICTParams.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static ZDICTParams mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static ZDICTParams callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static ZDICTParams mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static ZDICTParams callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static ZDICTParams.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static ZDICTParams.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static ZDICTParams.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static ZDICTParams.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static ZDICTParams malloc(org.lwjgl.system.MemoryStack stack)
Returns a newZDICTParamsinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static ZDICTParams calloc(org.lwjgl.system.MemoryStack stack)
Returns a newZDICTParamsinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static ZDICTParams.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newZDICTParams.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static ZDICTParams.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newZDICTParams.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ncompressionLevel
public static int ncompressionLevel(long struct)
Unsafe version ofcompressionLevel().
-
nnotificationLevel
public static int nnotificationLevel(long struct)
Unsafe version ofnotificationLevel().
-
ndictID
public static int ndictID(long struct)
Unsafe version ofdictID().
-
ncompressionLevel
public static void ncompressionLevel(long struct, int value)Unsafe version ofcompressionLevel.
-
nnotificationLevel
public static void nnotificationLevel(long struct, int value)Unsafe version ofnotificationLevel.
-
ndictID
public static void ndictID(long struct, int value)Unsafe version ofdictID.
-
-