Package org.lwjgl.util.zstd
Class ZSTDFrameParameters
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
Layout
struct ZSTD_frameParameters {
int contentSizeFlag()
;
int checksumFlag()
;
int noDictIDFlag()
;
}
-
Nested Class Summary
Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionZSTDFrameParameters
(ByteBuffer container) Creates aZSTDFrameParameters
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic ZSTDFrameParameters
calloc()
Returns a newZSTDFrameParameters
instance allocated withmemCalloc
.static ZSTDFrameParameters.Buffer
calloc
(int capacity) Returns a newZSTDFrameParameters.Buffer
instance allocated withmemCalloc
.static ZSTDFrameParameters.Buffer
calloc
(int capacity, MemoryStack stack) Returns a newZSTDFrameParameters.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static ZSTDFrameParameters
calloc
(MemoryStack stack) Returns a newZSTDFrameParameters
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static ZSTDFrameParameters
Deprecated.static ZSTDFrameParameters.Buffer
callocStack
(int capacity) Deprecated.static ZSTDFrameParameters.Buffer
callocStack
(int capacity, MemoryStack stack) Deprecated.static ZSTDFrameParameters
callocStack
(MemoryStack stack) Deprecated.int
1: generate a 32-bits checksum using XXH64 algorithm at end of frame, for error detectionchecksumFlag
(int value) Sets the specified value to thechecksumFlag()
field.int
1: content size will be in frame header (when known)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.Buffer
malloc
(int capacity, MemoryStack stack) Returns a newZSTDFrameParameters.Buffer
instance allocated on the specifiedMemoryStack
.static ZSTDFrameParameters
malloc
(MemoryStack stack) Returns a newZSTDFrameParameters
instance allocated on the specifiedMemoryStack
.static ZSTDFrameParameters
Deprecated.static ZSTDFrameParameters.Buffer
mallocStack
(int capacity) Deprecated.static ZSTDFrameParameters.Buffer
mallocStack
(int capacity, MemoryStack stack) Deprecated.static ZSTDFrameParameters
mallocStack
(MemoryStack stack) Deprecated.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
1: nodictID
will be saved into frame header (dictID
is only useful for dictionary compression)noDictIDFlag
(int value) Sets the specified value to thenoDictIDFlag()
field.set
(int contentSizeFlag, int checksumFlag, int noDictIDFlag) Initializes this struct with the specified values.set
(ZSTDFrameParameters src) Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
CONTENTSIZEFLAG
public static final int CONTENTSIZEFLAGThe struct member offsets. -
CHECKSUMFLAG
public static final int CHECKSUMFLAGThe struct member offsets. -
NODICTIDFLAG
public static final int NODICTIDFLAGThe struct member offsets.
-
-
Constructor Details
-
ZSTDFrameParameters
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<ZSTDFrameParameters>
-
contentSizeFlag
public int contentSizeFlag()1: content size will be in frame header (when known) -
checksumFlag
public int checksumFlag()1: generate a 32-bits checksum using XXH64 algorithm at end of frame, for error detection -
noDictIDFlag
public int noDictIDFlag()1: nodictID
will be saved into frame header (dictID
is only useful for dictionary compression) -
contentSizeFlag
Sets the specified value to thecontentSizeFlag()
field. -
checksumFlag
Sets the specified value to thechecksumFlag()
field. -
noDictIDFlag
Sets the specified value to thenoDictIDFlag()
field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newZSTDFrameParameters
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newZSTDFrameParameters
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newZSTDFrameParameters
instance allocated withBufferUtils
. -
create
Returns a newZSTDFrameParameters
instance for the specified memory address. -
createSafe
-
malloc
Returns a newZSTDFrameParameters.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newZSTDFrameParameters.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newZSTDFrameParameters.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aZSTDFrameParameters.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newZSTDFrameParameters
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newZSTDFrameParameters
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newZSTDFrameParameters.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newZSTDFrameParameters.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
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
.
-