Top Description Fields Methods
org.lwjgl.util.ktx

public Interface PFNKTXITERCBI

extends CallbackI
Known Direct Implementers
org.lwjgl.util.ktx.PFNKTXITERCB
Annotations
@FunctionalInterface
@NativeType:PFNKTXITERCB
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*

Type


KTX_error_code (*invoke) (
    int miplevel,
    int face,
    int width,
    int height,
    int depth,
    ktx_uint64_t faceLodSize,
    void *pixels,
    void *userdata
)

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 int
invoke(int
MIP level from 0 to the max level which is dependent on the texture size
miplevel, int
usually 0; for cube maps, one of the 6 cube faces in the order +X, -X, +Y, -Y, +Z, -Z, 0 to 5
face, int
width of the image
width, int
height of the image or, for 1D textures textures, 1
height, int
depth of the image or, for 1D & 2D textures, 1
depth, long
number of bytes of data pointed at by pixels
faceLodSize, long
pointer to the image data
pixels, long
pointer for the application to pass data to and from the callback function
userdata)

Signature of function called by the ktxTexture_Iterate* functions to receive image data.

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 int invoke(int miplevel, int face, int width, int height, int depth, long faceLodSize, long pixels, long userdata)

Signature of function called by the ktxTexture_Iterate* functions to receive image data.

The function parameters are used to pass values which change for each image. Obtain values which are uniform across all images from the ktxTexture object.

Parameters
miplevel:int

MIP level from 0 to the max level which is dependent on the texture size

face:int

usually 0; for cube maps, one of the 6 cube faces in the order +X, -X, +Y, -Y, +Z, -Z, 0 to 5

width:int

width of the image

height:int

height of the image or, for 1D textures textures, 1

depth:int

depth of the image or, for 1D & 2D textures, 1

faceLodSize:long

number of bytes of data pointed at by pixels

pixels:long

pointer to the image data

userdata:long

pointer for the application to pass data to and from the callback function

Annotations
@NativeType:KTX_error_code