Package org.lwjgl.util.zstd
Class ZSTDFrameHeader
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
struct ZSTD_FrameHeader {
unsigned long long frameContentSize;
unsigned long long windowSize;
unsigned int blockSizeMax;
ZSTD_FrameType_e frameType;
unsigned int headerSize;
unsigned int dictID;
unsigned int checksumFlag;
unsigned _reserved1;
unsigned _reserved2;
}
-
Nested Class Summary
Nested ClassesNested 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
FieldsModifier and TypeFieldDescriptionstatic final int
The struct member offsets.static final int
The struct member offsets.static 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 member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorsConstructorDescriptionZSTDFrameHeader
(ByteBuffer container) Creates aZSTDFrameHeader
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionint
static ZSTDFrameHeader
calloc()
Returns a newZSTDFrameHeader
instance allocated withmemCalloc
.static ZSTDFrameHeader.Buffer
calloc
(int capacity) Returns a newZSTDFrameHeader.Buffer
instance allocated withmemCalloc
.static ZSTDFrameHeader.Buffer
calloc
(int capacity, MemoryStack stack) Returns a newZSTDFrameHeader.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static ZSTDFrameHeader
calloc
(MemoryStack stack) Returns a newZSTDFrameHeader
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static ZSTDFrameHeader
Deprecated.static ZSTDFrameHeader.Buffer
callocStack
(int capacity) Deprecated.static ZSTDFrameHeader.Buffer
callocStack
(int capacity, MemoryStack stack) Deprecated.static ZSTDFrameHeader
callocStack
(MemoryStack stack) Deprecated.int
static ZSTDFrameHeader
create()
Returns a newZSTDFrameHeader
instance allocated withBufferUtils
.static ZSTDFrameHeader.Buffer
create
(int capacity) Returns a newZSTDFrameHeader.Buffer
instance allocated withBufferUtils
.static ZSTDFrameHeader
create
(long address) Returns a newZSTDFrameHeader
instance for the specified memory address.static ZSTDFrameHeader.Buffer
create
(long address, int capacity) Create aZSTDFrameHeader.Buffer
instance at the specified memory.static @Nullable ZSTDFrameHeader
createSafe
(long address) static @Nullable ZSTDFrameHeader.Buffer
createSafe
(long address, int capacity) int
dictID()
long
int
int
static ZSTDFrameHeader
malloc()
Returns a newZSTDFrameHeader
instance allocated withmemAlloc
.static ZSTDFrameHeader.Buffer
malloc
(int capacity) Returns a newZSTDFrameHeader.Buffer
instance allocated withmemAlloc
.static ZSTDFrameHeader.Buffer
malloc
(int capacity, MemoryStack stack) Returns a newZSTDFrameHeader.Buffer
instance allocated on the specifiedMemoryStack
.static ZSTDFrameHeader
malloc
(MemoryStack stack) Returns a newZSTDFrameHeader
instance allocated on the specifiedMemoryStack
.static ZSTDFrameHeader
Deprecated.static ZSTDFrameHeader.Buffer
mallocStack
(int capacity) Deprecated.static ZSTDFrameHeader.Buffer
mallocStack
(int capacity, MemoryStack stack) Deprecated.static ZSTDFrameHeader
mallocStack
(MemoryStack stack) Deprecated.static int
n_reserved1
(long struct) static int
n_reserved2
(long struct) static int
nblockSizeMax
(long struct) Unsafe version ofblockSizeMax()
.static int
nchecksumFlag
(long struct) Unsafe version ofchecksumFlag()
.static int
ndictID
(long struct) Unsafe version ofdictID()
.static long
nframeContentSize
(long struct) Unsafe version offrameContentSize()
.static int
nframeType
(long struct) Unsafe version offrameType()
.static int
nheaderSize
(long struct) Unsafe version ofheaderSize()
.static long
nwindowSize
(long struct) Unsafe version ofwindowSize()
.int
sizeof()
Returnssizeof(struct)
.long
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. -
FRAMECONTENTSIZE
public static final int FRAMECONTENTSIZEThe struct member offsets. -
WINDOWSIZE
public static final int WINDOWSIZEThe struct member offsets. -
BLOCKSIZEMAX
public static final int BLOCKSIZEMAXThe struct member offsets. -
FRAMETYPE
public static final int FRAMETYPEThe struct member offsets. -
HEADERSIZE
public static final int HEADERSIZEThe struct member offsets. -
DICTID
public static final int DICTIDThe struct member offsets. -
CHECKSUMFLAG
public static final int CHECKSUMFLAGThe struct member offsets. -
_RESERVED1
public static final int _RESERVED1The struct member offsets. -
_RESERVED2
public static final int _RESERVED2The struct member offsets.
-
-
Constructor Details
-
ZSTDFrameHeader
Creates aZSTDFrameHeader
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<ZSTDFrameHeader>
-
frameContentSize
public long frameContentSize()- Returns:
- the value of the
frameContentSize
field.
-
windowSize
public long windowSize()- Returns:
- the value of the
windowSize
field.
-
blockSizeMax
public int blockSizeMax()- Returns:
- the value of the
blockSizeMax
field.
-
frameType
public int frameType()- Returns:
- the value of the
frameType
field.
-
headerSize
public int headerSize()- Returns:
- the value of the
headerSize
field.
-
dictID
public int dictID()- Returns:
- the value of the
dictID
field.
-
checksumFlag
public int checksumFlag()- Returns:
- the value of the
checksumFlag
field.
-
malloc
Returns a newZSTDFrameHeader
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newZSTDFrameHeader
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newZSTDFrameHeader
instance allocated withBufferUtils
. -
create
Returns a newZSTDFrameHeader
instance for the specified memory address. -
createSafe
-
malloc
Returns a newZSTDFrameHeader.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newZSTDFrameHeader.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newZSTDFrameHeader.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aZSTDFrameHeader.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 newZSTDFrameHeader
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newZSTDFrameHeader
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newZSTDFrameHeader.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newZSTDFrameHeader.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nframeContentSize
public static long nframeContentSize(long struct) Unsafe version offrameContentSize()
. -
nwindowSize
public static long nwindowSize(long struct) Unsafe version ofwindowSize()
. -
nblockSizeMax
public static int nblockSizeMax(long struct) Unsafe version ofblockSizeMax()
. -
nframeType
public static int nframeType(long struct) Unsafe version offrameType()
. -
nheaderSize
public static int nheaderSize(long struct) Unsafe version ofheaderSize()
. -
ndictID
public static int ndictID(long struct) Unsafe version ofdictID()
. -
nchecksumFlag
public static int nchecksumFlag(long struct) Unsafe version ofchecksumFlag()
. -
n_reserved1
public static int n_reserved1(long struct) -
n_reserved2
public static int n_reserved2(long struct)
-