Top Description Fields Methods
org.lwjgl.stb

public Interface STBIZlibCompressI

extends CallbackI
Known Direct Implementers
org.lwjgl.stb.STBIZlibCompress
Annotations
@FunctionalInterface
@NativeType:unsigned char * (*) (unsigned char *, int, int *, int)
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*
Instances of this interface may be set to STBImageWrite#stbi_zlib_compress.

Type


unsigned char * (*invoke) (
    unsigned char *data,
    int data_len,
    int *out_len,
    int quality
)

Field Summary

Modifier and TypeField and Description
public static final FFICIF
CIF

Method Summary

Modifier and TypeMethod and Description
public default void
callback(long
a pointer to the memory used for the function's return value.

If the function is declared as returning void, then this value is garbage and should not be used.

Otherwise, the callback must fill the object to which this points, following the same special promotion behavior as LibFFI#ffi_call. That is, in most cases, ret points to an object of exactly the size of the type specified when CIF was constructed. However, integral types narrower than the system register size are widened. In these cases your program may assume that ret points to an ffi_arg object.

ret, long
a vector of pointers to memory holding the arguments to the function
args)

Implements org.lwjgl.system.CallbackI.callback.

The Java method that will be called from native code when the native callback function is invoked.
public default FFICIF
getCallInterface()

Implements org.lwjgl.system.CallbackI.getCallInterface.

Returns the libffi Call Interface for this callback function.
public long

Returns:

the compressed data
invoke(long
the data to compress
data, int
the data length, in bytes
data_len, long
returns the compressed data length, in bytes
out_len, int
the compression quality to use
quality)

Compresses a block of data using Zlib compression.

Inherited from org.lwjgl.system.CallbackI:
address

Field Detail

CIFback to summary
public static final FFICIF CIF

Method Detail

callbackback to summary
public default void callback(long ret, long args)

Implements org.lwjgl.system.CallbackI.callback.

Doc from org.lwjgl.system.CallbackI.callback.

The Java method that will be called from native code when the native callback function is invoked.

Parameters
ret:long

a pointer to the memory used for the function's return value.

If the function is declared as returning void, then this value is garbage and should not be used.

Otherwise, the callback must fill the object to which this points, following the same special promotion behavior as LibFFI#ffi_call. That is, in most cases, ret points to an object of exactly the size of the type specified when CIF was constructed. However, integral types narrower than the system register size are widened. In these cases your program may assume that ret points to an ffi_arg object.

args:long

a vector of pointers to memory holding the arguments to the function

Annotations
@Override
getCallInterfaceback to summary
public default FFICIF getCallInterface()

Implements org.lwjgl.system.CallbackI.getCallInterface.

Doc from org.lwjgl.system.CallbackI.getCallInterface.

Returns the libffi Call Interface for this callback function. [INTERNAL API]

Returns:FFICIF

the CIF structure for this callback function

Annotations
@Override
invokeback to summary
public long invoke(long data, int data_len, long out_len, int quality)

Compresses a block of data using Zlib compression.

The returned data will be freed with MemoryUtil#memFree so it must be heap allocated with MemoryUtil#memAlloc.

Parameters
data:long

the data to compress

data_len:int

the data length, in bytes

out_len:long

returns the compressed data length, in bytes

quality:int

the compression quality to use

Returns:long

the compressed data

Annotations
@NativeType:unsigned char *