Package org.lwjgl.util.lz4
Class LZ4FCompressOptions
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.util.lz4.LZ4FCompressOptions
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class LZ4FCompressOptions extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Member documentation
stableSrc
–1 == src
content will remain present on future calls toLZ4F_compress()
; skip copyingsrc
content withintmp
buffer
Layout
struct LZ4F_compressOptions_t { unsigned stableSrc; unsigned reserved[3]; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LZ4FCompressOptions.Buffer
An array ofLZ4FCompressOptions
structs.
-
Constructor Summary
Constructors Constructor Description LZ4FCompressOptions(java.nio.ByteBuffer container)
Creates aLZ4FCompressOptions
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 LZ4FCompressOptions
calloc()
Returns a newLZ4FCompressOptions
instance allocated withmemCalloc
.static LZ4FCompressOptions.Buffer
calloc(int capacity)
Returns a newLZ4FCompressOptions.Buffer
instance allocated withmemCalloc
.static LZ4FCompressOptions
callocStack()
Returns a newLZ4FCompressOptions
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static LZ4FCompressOptions.Buffer
callocStack(int capacity)
Returns a newLZ4FCompressOptions.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static LZ4FCompressOptions.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newLZ4FCompressOptions.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static LZ4FCompressOptions
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newLZ4FCompressOptions
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static LZ4FCompressOptions
create()
Returns a newLZ4FCompressOptions
instance allocated withBufferUtils
.static LZ4FCompressOptions.Buffer
create(int capacity)
Returns a newLZ4FCompressOptions.Buffer
instance allocated withBufferUtils
.static LZ4FCompressOptions
create(long address)
Returns a newLZ4FCompressOptions
instance for the specified memory address.static LZ4FCompressOptions.Buffer
create(long address, int capacity)
Create aLZ4FCompressOptions.Buffer
instance at the specified memory.static LZ4FCompressOptions
createSafe(long address)
static LZ4FCompressOptions.Buffer
createSafe(long address, int capacity)
static LZ4FCompressOptions
malloc()
Returns a newLZ4FCompressOptions
instance allocated withmemAlloc
.static LZ4FCompressOptions.Buffer
malloc(int capacity)
Returns a newLZ4FCompressOptions.Buffer
instance allocated withmemAlloc
.static LZ4FCompressOptions
mallocStack()
Returns a newLZ4FCompressOptions
instance allocated on the thread-localMemoryStack
.static LZ4FCompressOptions.Buffer
mallocStack(int capacity)
Returns a newLZ4FCompressOptions.Buffer
instance allocated on the thread-localMemoryStack
.static LZ4FCompressOptions.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newLZ4FCompressOptions.Buffer
instance allocated on the specifiedMemoryStack
.static LZ4FCompressOptions
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newLZ4FCompressOptions
instance allocated on the specifiedMemoryStack
.static java.nio.IntBuffer
nreserved(long struct)
Unsafe version ofreserved()
.static int
nreserved(long struct, int index)
Unsafe version ofreserved
.static void
nreserved(long struct, int index, int value)
Unsafe version ofreserved
.static void
nreserved(long struct, java.nio.IntBuffer value)
Unsafe version ofreserved
.static int
nstableSrc(long struct)
Unsafe version ofstableSrc()
.static void
nstableSrc(long struct, int value)
Unsafe version ofstableSrc
.java.nio.IntBuffer
reserved()
Returns aIntBuffer
view of thereserved
field.int
reserved(int index)
Returns the value at the specified index of thereserved
field.LZ4FCompressOptions
reserved(int index, int value)
Sets the specified value at the specified index of thereserved
field.LZ4FCompressOptions
reserved(java.nio.IntBuffer value)
Copies the specifiedIntBuffer
to thereserved
field.LZ4FCompressOptions
set(int stableSrc, java.nio.IntBuffer reserved)
Initializes this struct with the specified values.LZ4FCompressOptions
set(LZ4FCompressOptions src)
Copies the specified struct data to this struct.int
sizeof()
int
stableSrc()
Returns the value of thestableSrc
field.LZ4FCompressOptions
stableSrc(int value)
Sets the specified value to thestableSrc
field.
-
-
-
Constructor Detail
-
LZ4FCompressOptions
public LZ4FCompressOptions(java.nio.ByteBuffer container)
Creates aLZ4FCompressOptions
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
-
stableSrc
public int stableSrc()
Returns the value of thestableSrc
field.
-
reserved
public java.nio.IntBuffer reserved()
Returns aIntBuffer
view of thereserved
field.
-
reserved
public int reserved(int index)
Returns the value at the specified index of thereserved
field.
-
stableSrc
public LZ4FCompressOptions stableSrc(int value)
Sets the specified value to thestableSrc
field.
-
reserved
public LZ4FCompressOptions reserved(java.nio.IntBuffer value)
Copies the specifiedIntBuffer
to thereserved
field.
-
reserved
public LZ4FCompressOptions reserved(int index, int value)
Sets the specified value at the specified index of thereserved
field.
-
set
public LZ4FCompressOptions set(int stableSrc, java.nio.IntBuffer reserved)
Initializes this struct with the specified values.
-
set
public LZ4FCompressOptions set(LZ4FCompressOptions src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static LZ4FCompressOptions malloc()
Returns a newLZ4FCompressOptions
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static LZ4FCompressOptions calloc()
Returns a newLZ4FCompressOptions
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static LZ4FCompressOptions create()
Returns a newLZ4FCompressOptions
instance allocated withBufferUtils
.
-
create
public static LZ4FCompressOptions create(long address)
Returns a newLZ4FCompressOptions
instance for the specified memory address.
-
createSafe
@Nullable public static LZ4FCompressOptions createSafe(long address)
-
malloc
public static LZ4FCompressOptions.Buffer malloc(int capacity)
Returns a newLZ4FCompressOptions.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static LZ4FCompressOptions.Buffer calloc(int capacity)
Returns a newLZ4FCompressOptions.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static LZ4FCompressOptions.Buffer create(int capacity)
Returns a newLZ4FCompressOptions.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static LZ4FCompressOptions.Buffer create(long address, int capacity)
Create aLZ4FCompressOptions.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static LZ4FCompressOptions.Buffer createSafe(long address, int capacity)
-
mallocStack
public static LZ4FCompressOptions mallocStack()
Returns a newLZ4FCompressOptions
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static LZ4FCompressOptions callocStack()
Returns a newLZ4FCompressOptions
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static LZ4FCompressOptions mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newLZ4FCompressOptions
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static LZ4FCompressOptions callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newLZ4FCompressOptions
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static LZ4FCompressOptions.Buffer mallocStack(int capacity)
Returns a newLZ4FCompressOptions.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static LZ4FCompressOptions.Buffer callocStack(int capacity)
Returns a newLZ4FCompressOptions.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static LZ4FCompressOptions.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newLZ4FCompressOptions.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static LZ4FCompressOptions.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newLZ4FCompressOptions.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nstableSrc
public static int nstableSrc(long struct)
Unsafe version ofstableSrc()
.
-
nreserved
public static java.nio.IntBuffer nreserved(long struct)
Unsafe version ofreserved()
.
-
nreserved
public static int nreserved(long struct, int index)
Unsafe version ofreserved
.
-
nstableSrc
public static void nstableSrc(long struct, int value)
Unsafe version ofstableSrc
.
-
nreserved
public static void nreserved(long struct, java.nio.IntBuffer value)
Unsafe version ofreserved
.
-
nreserved
public static void nreserved(long struct, int index, int value)
Unsafe version ofreserved
.
-
-