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.NativeResourceLayout
struct ZSTD_frameParameters { intcontentSizeFlag(); intchecksumFlag(); intnoDictIDFlag(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classZSTDFrameParameters.BufferAn array ofZSTDFrameParametersstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intCHECKSUMFLAG
CONTENTSIZEFLAG
NODICTIDFLAGThe struct member offsets.static intSIZEOFThe struct size in bytes.
-
Constructor Summary
Constructors Constructor Description ZSTDFrameParameters(java.nio.ByteBuffer container)Creates aZSTDFrameParametersinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static ZSTDFrameParameterscalloc()Returns a newZSTDFrameParametersinstance allocated withmemCalloc.static ZSTDFrameParameters.Buffercalloc(int capacity)Returns a newZSTDFrameParameters.Bufferinstance allocated withmemCalloc.static ZSTDFrameParameters.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newZSTDFrameParameters.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static ZSTDFrameParameterscalloc(org.lwjgl.system.MemoryStack stack)Returns a newZSTDFrameParametersinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static ZSTDFrameParameterscallocStack()Deprecated.static ZSTDFrameParameters.BuffercallocStack(int capacity)Deprecated.static ZSTDFrameParameters.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static ZSTDFrameParameterscallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.intchecksumFlag()1: generate a 32-bits checksum using XXH64 algorithm at end of frame, for error detectionZSTDFrameParameterschecksumFlag(int value)Sets the specified value to thechecksumFlag()field.intcontentSizeFlag()1: content size will be in frame header (when known)ZSTDFrameParameterscontentSizeFlag(int value)Sets the specified value to thecontentSizeFlag()field.static ZSTDFrameParameterscreate()Returns a newZSTDFrameParametersinstance allocated withBufferUtils.static ZSTDFrameParameters.Buffercreate(int capacity)Returns a newZSTDFrameParameters.Bufferinstance allocated withBufferUtils.static ZSTDFrameParameterscreate(long address)Returns a newZSTDFrameParametersinstance for the specified memory address.static ZSTDFrameParameters.Buffercreate(long address, int capacity)Create aZSTDFrameParameters.Bufferinstance at the specified memory.static ZSTDFrameParameterscreateSafe(long address)static ZSTDFrameParameters.BuffercreateSafe(long address, int capacity)static ZSTDFrameParametersmalloc()Returns a newZSTDFrameParametersinstance allocated withmemAlloc.static ZSTDFrameParameters.Buffermalloc(int capacity)Returns a newZSTDFrameParameters.Bufferinstance allocated withmemAlloc.static ZSTDFrameParameters.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newZSTDFrameParameters.Bufferinstance allocated on the specifiedMemoryStack.static ZSTDFrameParametersmalloc(org.lwjgl.system.MemoryStack stack)Returns a newZSTDFrameParametersinstance allocated on the specifiedMemoryStack.static ZSTDFrameParametersmallocStack()Deprecated.static ZSTDFrameParameters.BuffermallocStack(int capacity)Deprecated.static ZSTDFrameParameters.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static ZSTDFrameParametersmallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static intnchecksumFlag(long struct)Unsafe version ofchecksumFlag().static voidnchecksumFlag(long struct, int value)Unsafe version ofchecksumFlag.static intncontentSizeFlag(long struct)Unsafe version ofcontentSizeFlag().static voidncontentSizeFlag(long struct, int value)Unsafe version ofcontentSizeFlag.static intnnoDictIDFlag(long struct)Unsafe version ofnoDictIDFlag().static voidnnoDictIDFlag(long struct, int value)Unsafe version ofnoDictIDFlag.intnoDictIDFlag()1: nodictIDwill be saved into frame header (dictIDis only useful for dictionary compression)ZSTDFrameParametersnoDictIDFlag(int value)Sets the specified value to thenoDictIDFlag()field.ZSTDFrameParametersset(int contentSizeFlag, int checksumFlag, int noDictIDFlag)Initializes this struct with the specified values.ZSTDFrameParametersset(ZSTDFrameParameters src)Copies the specified struct data to this struct.intsizeof()
-
-
-
Constructor Detail
-
ZSTDFrameParameters
public ZSTDFrameParameters(java.nio.ByteBuffer container)
Creates aZSTDFrameParametersinstance 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
-
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: nodictIDwill be saved into frame header (dictIDis only useful for dictionary compression)
-
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 newZSTDFrameParametersinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static ZSTDFrameParameters calloc()
Returns a newZSTDFrameParametersinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static ZSTDFrameParameters create()
Returns a newZSTDFrameParametersinstance allocated withBufferUtils.
-
create
public static ZSTDFrameParameters create(long address)
Returns a newZSTDFrameParametersinstance for the specified memory address.
-
createSafe
@Nullable public static ZSTDFrameParameters createSafe(long address)
-
malloc
public static ZSTDFrameParameters.Buffer malloc(int capacity)
Returns a newZSTDFrameParameters.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static ZSTDFrameParameters.Buffer calloc(int capacity)
Returns a newZSTDFrameParameters.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static ZSTDFrameParameters.Buffer create(int capacity)
Returns a newZSTDFrameParameters.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static ZSTDFrameParameters.Buffer create(long address, int capacity)
Create aZSTDFrameParameters.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static ZSTDFrameParameters.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static ZSTDFrameParameters mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static ZSTDFrameParameters callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static ZSTDFrameParameters mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static ZSTDFrameParameters callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static ZSTDFrameParameters.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static ZSTDFrameParameters.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static ZSTDFrameParameters.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 ZSTDFrameParameters.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static ZSTDFrameParameters malloc(org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameParametersinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static ZSTDFrameParameters calloc(org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameParametersinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static ZSTDFrameParameters.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameParameters.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static ZSTDFrameParameters.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newZSTDFrameParameters.Bufferinstance allocated on the specifiedMemoryStackand 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.
-
-