Package org.lwjgl.util.zstd
Class ZSTDFrameHeader
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.util.zstd.ZSTDFrameHeader
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class ZSTDFrameHeader extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceLayout
struct ZSTD_frameHeader { unsigned long longframeContentSize(); unsigned long longwindowSize(); unsigned int blockSizeMax; ZSTD_frameType_eframeType(); unsigned int headerSize; unsigned int dictID; unsigned int checksumFlag; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classZSTDFrameHeader.BufferAn array ofZSTDFrameHeaderstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intBLOCKSIZEMAX
CHECKSUMFLAG
DICTID
FRAMECONTENTSIZE
FRAMETYPE
HEADERSIZEThe struct member offsets.static intSIZEOFThe struct size in bytes.static intWINDOWSIZEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description ZSTDFrameHeader(java.nio.ByteBuffer container)Creates aZSTDFrameHeaderinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description intblockSizeMax()static ZSTDFrameHeadercalloc()Returns a newZSTDFrameHeaderinstance allocated withmemCalloc.static ZSTDFrameHeader.Buffercalloc(int capacity)Returns a newZSTDFrameHeader.Bufferinstance allocated withmemCalloc.static ZSTDFrameHeader.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newZSTDFrameHeader.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static ZSTDFrameHeadercalloc(org.lwjgl.system.MemoryStack stack)Returns a newZSTDFrameHeaderinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static ZSTDFrameHeadercallocStack()Deprecated.static ZSTDFrameHeader.BuffercallocStack(int capacity)Deprecated.static ZSTDFrameHeader.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static ZSTDFrameHeadercallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.intchecksumFlag()static ZSTDFrameHeadercreate()Returns a newZSTDFrameHeaderinstance allocated withBufferUtils.static ZSTDFrameHeader.Buffercreate(int capacity)Returns a newZSTDFrameHeader.Bufferinstance allocated withBufferUtils.static ZSTDFrameHeadercreate(long address)Returns a newZSTDFrameHeaderinstance for the specified memory address.static ZSTDFrameHeader.Buffercreate(long address, int capacity)Create aZSTDFrameHeader.Bufferinstance at the specified memory.static ZSTDFrameHeadercreateSafe(long address)static ZSTDFrameHeader.BuffercreateSafe(long address, int capacity)intdictID()longframeContentSize()if ==CONTENTSIZE_UNKNOWN, it means this field is not available.intframeType()if ==skippableFrame,frameContentSizeis the size of skippable contentintheaderSize()static ZSTDFrameHeadermalloc()Returns a newZSTDFrameHeaderinstance allocated withmemAlloc.static ZSTDFrameHeader.Buffermalloc(int capacity)Returns a newZSTDFrameHeader.Bufferinstance allocated withmemAlloc.static ZSTDFrameHeader.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newZSTDFrameHeader.Bufferinstance allocated on the specifiedMemoryStack.static ZSTDFrameHeadermalloc(org.lwjgl.system.MemoryStack stack)Returns a newZSTDFrameHeaderinstance allocated on the specifiedMemoryStack.static ZSTDFrameHeadermallocStack()Deprecated.static ZSTDFrameHeader.BuffermallocStack(int capacity)Deprecated.static ZSTDFrameHeader.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static ZSTDFrameHeadermallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static intnblockSizeMax(long struct)Unsafe version ofblockSizeMax().static intnchecksumFlag(long struct)Unsafe version ofchecksumFlag().static intndictID(long struct)Unsafe version ofdictID().static longnframeContentSize(long struct)Unsafe version offrameContentSize().static intnframeType(long struct)Unsafe version offrameType().static intnheaderSize(long struct)Unsafe version ofheaderSize().static longnwindowSize(long struct)Unsafe version ofwindowSize().intsizeof()longwindowSize()can be very large, up to ≤frameContentSize
-
-
-
Constructor Detail
-
ZSTDFrameHeader
public ZSTDFrameHeader(java.nio.ByteBuffer container)
Creates aZSTDFrameHeaderinstance 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
-
frameContentSize
public long frameContentSize()
if ==CONTENTSIZE_UNKNOWN, it means this field is not available. 0 means "empty"
-
windowSize
public long windowSize()
can be very large, up to ≤frameContentSize
-
blockSizeMax
public int blockSizeMax()
- Returns:
- the value of the
blockSizeMaxfield.
-
frameType
public int frameType()
if ==skippableFrame,frameContentSizeis the size of skippable content
-
headerSize
public int headerSize()
- Returns:
- the value of the
headerSizefield.
-
dictID
public int dictID()
- Returns:
- the value of the
dictIDfield.
-
checksumFlag
public int checksumFlag()
- Returns:
- the value of the
checksumFlagfield.
-
malloc
public static ZSTDFrameHeader malloc()
Returns a newZSTDFrameHeaderinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static ZSTDFrameHeader calloc()
Returns a newZSTDFrameHeaderinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static ZSTDFrameHeader create()
Returns a newZSTDFrameHeaderinstance allocated withBufferUtils.
-
create
public static ZSTDFrameHeader create(long address)
Returns a newZSTDFrameHeaderinstance for the specified memory address.
-
createSafe
@Nullable public static ZSTDFrameHeader createSafe(long address)
-
malloc
public static ZSTDFrameHeader.Buffer malloc(int capacity)
Returns a newZSTDFrameHeader.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static ZSTDFrameHeader.Buffer calloc(int capacity)
Returns a newZSTDFrameHeader.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static ZSTDFrameHeader.Buffer create(int capacity)
Returns a newZSTDFrameHeader.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static ZSTDFrameHeader.Buffer create(long address, int capacity)
Create aZSTDFrameHeader.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static ZSTDFrameHeader.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static ZSTDFrameHeader mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static ZSTDFrameHeader callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static ZSTDFrameHeader mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static ZSTDFrameHeader callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static ZSTDFrameHeader.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static ZSTDFrameHeader.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static ZSTDFrameHeader.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 ZSTDFrameHeader.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static ZSTDFrameHeader malloc(org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameHeaderinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static ZSTDFrameHeader calloc(org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameHeaderinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static ZSTDFrameHeader.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameHeader.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static ZSTDFrameHeader.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameHeader.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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().
-
-