Package org.lwjgl.util.zstd
Class ZSTDFrameParameters
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.util.zstd.ZSTDFrameParameters
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class ZSTDFrameParameters extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Member documentation
contentSizeFlag
– 1: content size will be in frame header (when known)checksumFlag
– 1: generate a 32-bits checksum using XXH64 algorithm at end of frame, for error detectionnoDictIDFlag
– 1: nodictID
will be saved into frame header (dictID
is only useful for dictionary compression)
Layout
struct ZSTD_frameParameters { int contentSizeFlag; int checksumFlag; int noDictIDFlag; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ZSTDFrameParameters.Buffer
An array ofZSTDFrameParameters
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
CHECKSUMFLAG
CONTENTSIZEFLAG
NODICTIDFLAGThe struct member offsets.static int
SIZEOF
The struct size in bytes.
-
Constructor Summary
Constructors Constructor Description ZSTDFrameParameters(java.nio.ByteBuffer container)
Creates aZSTDFrameParameters
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ZSTDFrameParameters
calloc()
Returns a newZSTDFrameParameters
instance allocated withmemCalloc
.static ZSTDFrameParameters.Buffer
calloc(int capacity)
Returns a newZSTDFrameParameters.Buffer
instance allocated withmemCalloc
.static ZSTDFrameParameters
callocStack()
Returns a newZSTDFrameParameters
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static ZSTDFrameParameters.Buffer
callocStack(int capacity)
Returns a newZSTDFrameParameters.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static ZSTDFrameParameters.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameParameters.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static ZSTDFrameParameters
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameParameters
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.int
checksumFlag()
Returns the value of thechecksumFlag
field.ZSTDFrameParameters
checksumFlag(int value)
Sets the specified value to thechecksumFlag
field.int
contentSizeFlag()
Returns the value of thecontentSizeFlag
field.ZSTDFrameParameters
contentSizeFlag(int value)
Sets the specified value to thecontentSizeFlag
field.static ZSTDFrameParameters
create()
Returns a newZSTDFrameParameters
instance allocated withBufferUtils
.static ZSTDFrameParameters.Buffer
create(int capacity)
Returns a newZSTDFrameParameters.Buffer
instance allocated withBufferUtils
.static ZSTDFrameParameters
create(long address)
Returns a newZSTDFrameParameters
instance for the specified memory address.static ZSTDFrameParameters.Buffer
create(long address, int capacity)
Create aZSTDFrameParameters.Buffer
instance at the specified memory.static ZSTDFrameParameters
createSafe(long address)
static ZSTDFrameParameters.Buffer
createSafe(long address, int capacity)
static ZSTDFrameParameters
malloc()
Returns a newZSTDFrameParameters
instance allocated withmemAlloc
.static ZSTDFrameParameters.Buffer
malloc(int capacity)
Returns a newZSTDFrameParameters.Buffer
instance allocated withmemAlloc
.static ZSTDFrameParameters
mallocStack()
Returns a newZSTDFrameParameters
instance allocated on the thread-localMemoryStack
.static ZSTDFrameParameters.Buffer
mallocStack(int capacity)
Returns a newZSTDFrameParameters.Buffer
instance allocated on the thread-localMemoryStack
.static ZSTDFrameParameters.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameParameters.Buffer
instance allocated on the specifiedMemoryStack
.static ZSTDFrameParameters
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameParameters
instance allocated on the specifiedMemoryStack
.static int
nchecksumFlag(long struct)
Unsafe version ofchecksumFlag()
.static void
nchecksumFlag(long struct, int value)
Unsafe version ofchecksumFlag
.static int
ncontentSizeFlag(long struct)
Unsafe version ofcontentSizeFlag()
.static void
ncontentSizeFlag(long struct, int value)
Unsafe version ofcontentSizeFlag
.static int
nnoDictIDFlag(long struct)
Unsafe version ofnoDictIDFlag()
.static void
nnoDictIDFlag(long struct, int value)
Unsafe version ofnoDictIDFlag
.int
noDictIDFlag()
Returns the value of thenoDictIDFlag
field.ZSTDFrameParameters
noDictIDFlag(int value)
Sets the specified value to thenoDictIDFlag
field.ZSTDFrameParameters
set(int contentSizeFlag, int checksumFlag, int noDictIDFlag)
Initializes this struct with the specified values.ZSTDFrameParameters
set(ZSTDFrameParameters src)
Copies the specified struct data to this struct.int
sizeof()
-
-
-
Constructor Detail
-
ZSTDFrameParameters
public ZSTDFrameParameters(java.nio.ByteBuffer container)
Creates aZSTDFrameParameters
instance at the current position of the specifiedByteBuffer
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
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
contentSizeFlag
public int contentSizeFlag()
Returns the value of thecontentSizeFlag
field.
-
checksumFlag
public int checksumFlag()
Returns the value of thechecksumFlag
field.
-
noDictIDFlag
public int noDictIDFlag()
Returns the value of thenoDictIDFlag
field.
-
contentSizeFlag
public ZSTDFrameParameters contentSizeFlag(int value)
Sets the specified value to thecontentSizeFlag
field.
-
checksumFlag
public ZSTDFrameParameters checksumFlag(int value)
Sets the specified value to thechecksumFlag
field.
-
noDictIDFlag
public ZSTDFrameParameters noDictIDFlag(int value)
Sets the specified value to thenoDictIDFlag
field.
-
set
public ZSTDFrameParameters set(int contentSizeFlag, int checksumFlag, int noDictIDFlag)
Initializes this struct with the specified values.
-
set
public ZSTDFrameParameters set(ZSTDFrameParameters src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static ZSTDFrameParameters malloc()
Returns a newZSTDFrameParameters
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static ZSTDFrameParameters calloc()
Returns a newZSTDFrameParameters
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static ZSTDFrameParameters create()
Returns a newZSTDFrameParameters
instance allocated withBufferUtils
.
-
create
public static ZSTDFrameParameters create(long address)
Returns a newZSTDFrameParameters
instance for the specified memory address.
-
createSafe
@Nullable public static ZSTDFrameParameters createSafe(long address)
-
malloc
public static ZSTDFrameParameters.Buffer malloc(int capacity)
Returns a newZSTDFrameParameters.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static ZSTDFrameParameters.Buffer calloc(int capacity)
Returns a newZSTDFrameParameters.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static ZSTDFrameParameters.Buffer create(int capacity)
Returns a newZSTDFrameParameters.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static ZSTDFrameParameters.Buffer create(long address, int capacity)
Create aZSTDFrameParameters.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static ZSTDFrameParameters.Buffer createSafe(long address, int capacity)
-
mallocStack
public static ZSTDFrameParameters mallocStack()
Returns a newZSTDFrameParameters
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static ZSTDFrameParameters callocStack()
Returns a newZSTDFrameParameters
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static ZSTDFrameParameters mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameParameters
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static ZSTDFrameParameters callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameParameters
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static ZSTDFrameParameters.Buffer mallocStack(int capacity)
Returns a newZSTDFrameParameters.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static ZSTDFrameParameters.Buffer callocStack(int capacity)
Returns a newZSTDFrameParameters.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static ZSTDFrameParameters.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameParameters.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static ZSTDFrameParameters.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameParameters.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
ncontentSizeFlag
public static int ncontentSizeFlag(long struct)
Unsafe version ofcontentSizeFlag()
.
-
nchecksumFlag
public static int nchecksumFlag(long struct)
Unsafe version ofchecksumFlag()
.
-
nnoDictIDFlag
public static int nnoDictIDFlag(long struct)
Unsafe version ofnoDictIDFlag()
.
-
ncontentSizeFlag
public static void ncontentSizeFlag(long struct, int value)
Unsafe version ofcontentSizeFlag
.
-
nchecksumFlag
public static void nchecksumFlag(long struct, int value)
Unsafe version ofchecksumFlag
.
-
nnoDictIDFlag
public static void nnoDictIDFlag(long struct, int value)
Unsafe version ofnoDictIDFlag
.
-
-