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.NativeResourceMember documentation
compressionLevel– optimize for a specific zstd compression level; 0 means defaultnotificationLevel– write log tostderr; 0 = none (default); 1 = errors; 2 = progression; 3 = details; 4 = debug;dictID– forcedictIDvalue; 0 means auto mode (32-bits random value)
Layout
struct ZDICT_params_t { int compressionLevel; unsigned notificationLevel; unsigned dictID; }
-
-
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 Modifier and Type Method Description static ZDICTParamscalloc()Returns a newZDICTParamsinstance allocated withmemCalloc.static ZDICTParams.Buffercalloc(int capacity)Returns a newZDICTParams.Bufferinstance allocated withmemCalloc.static ZDICTParamscallocStack()Returns a newZDICTParamsinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static ZDICTParams.BuffercallocStack(int capacity)Returns a newZDICTParams.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static ZDICTParams.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newZDICTParams.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static ZDICTParamscallocStack(org.lwjgl.system.MemoryStack stack)Returns a newZDICTParamsinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.intcompressionLevel()Returns the value of thecompressionLevelfield.ZDICTParamscompressionLevel(int value)Sets the specified value to thecompressionLevelfield.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()Returns the value of thedictIDfield.ZDICTParamsdictID(int value)Sets the specified value to thedictIDfield.static ZDICTParamsmalloc()Returns a newZDICTParamsinstance allocated withmemAlloc.static ZDICTParams.Buffermalloc(int capacity)Returns a newZDICTParams.Bufferinstance allocated withmemAlloc.static ZDICTParamsmallocStack()Returns a newZDICTParamsinstance allocated on the thread-localMemoryStack.static ZDICTParams.BuffermallocStack(int capacity)Returns a newZDICTParams.Bufferinstance allocated on the thread-localMemoryStack.static ZDICTParams.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newZDICTParams.Bufferinstance allocated on the specifiedMemoryStack.static ZDICTParamsmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newZDICTParamsinstance allocated on the specifiedMemoryStack.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()Returns the value of thenotificationLevelfield.ZDICTParamsnotificationLevel(int value)Sets the specified value to thenotificationLevelfield.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()
Returns the value of thecompressionLevelfield.
-
notificationLevel
public int notificationLevel()
Returns the value of thenotificationLevelfield.
-
dictID
public int dictID()
Returns the value of thedictIDfield.
-
compressionLevel
public ZDICTParams compressionLevel(int value)
Sets the specified value to thecompressionLevelfield.
-
notificationLevel
public ZDICTParams notificationLevel(int value)
Sets the specified value to thenotificationLevelfield.
-
dictID
public ZDICTParams dictID(int value)
Sets the specified value to thedictIDfield.
-
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
public static ZDICTParams mallocStack()
Returns a newZDICTParamsinstance allocated on the thread-localMemoryStack.
-
callocStack
public static ZDICTParams callocStack()
Returns a newZDICTParamsinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static ZDICTParams mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newZDICTParamsinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static ZDICTParams callocStack(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
-
mallocStack
public static ZDICTParams.Buffer mallocStack(int capacity)
Returns a newZDICTParams.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static ZDICTParams.Buffer callocStack(int capacity)
Returns a newZDICTParams.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static ZDICTParams.Buffer mallocStack(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
-
callocStack
public static ZDICTParams.Buffer callocStack(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.
-
-