Package org.lwjgl.stb

Interface STBIZlibCompressI

All Superinterfaces:
CallbackI, Pointer
All Known Implementing Classes:
STBIZlibCompress
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface public interface STBIZlibCompressI extends CallbackI
Instances of this interface may be set to STBImageWrite.stbi_zlib_compress.

Type


 unsigned char * (*invoke(long, int, long, int)) (
     unsigned char *data,
     int data_len,
     int *out_len,
     int quality
 )
  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

    Pointer.Default
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final FFICIF
     

    Fields inherited from interface org.lwjgl.system.Pointer

    BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    callback(long ret, long args)
    The Java method that will be called from native code when the native callback function is invoked.
    default FFICIF
    Returns the libffi Call Interface for this callback function.
    long
    invoke(long data, int data_len, long out_len, int quality)
    Compresses a block of data using Zlib compression.

    Methods inherited from interface org.lwjgl.system.CallbackI

    address
  • Field Details

    • CIF

      static final FFICIF CIF
  • Method Details

    • getCallInterface

      default FFICIF getCallInterface()
      Description copied from interface: CallbackI
      Returns the libffi Call Interface for this callback function. [INTERNAL API]
      Specified by:
      getCallInterface in interface CallbackI
      Returns:
      the CIF structure for this callback function
    • callback

      default void callback(long ret, long args)
      Description copied from interface: CallbackI
      The Java method that will be called from native code when the native callback function is invoked.
      Specified by:
      callback in interface CallbackI
      Parameters:
      ret - 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(org.lwjgl.system.libffi.FFICIF, long, java.nio.ByteBuffer, org.lwjgl.PointerBuffer). 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 - a vector of pointers to memory holding the arguments to the function
    • invoke

      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(java.nio.Buffer) so it must be heap allocated with MemoryUtil.memAlloc(int).

      Parameters:
      data - the data to compress
      data_len - the data length, in bytes
      out_len - returns the compressed data length, in bytes
      quality - the compression quality to use
      Returns:
      the compressed data