Top Description Inners Constructors Methods
org.lwjgl.util.ktx

public abstract Class PFNKTXITERCB

extends Callback
implements PFNKTXITERCBI
Class Inheritance
All Implemented Interfaces
org.lwjgl.util.ktx.PFNKTXITERCBI, org.lwjgl.system.CallbackI, org.lwjgl.system.Pointer
Known Direct Subclasses
org.lwjgl.util.ktx.PFNKTXITERCB.Container
Imports
javax.annotation.*, org.lwjgl.system.*

Type


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
PFNKTXITERCB.Container

Constructor Summary

AccessConstructor and Description
protected
PFNKTXITERCB()

pack-priv
PFNKTXITERCB(long functionPointer)

Method Summary

Modifier and TypeMethod and Description
public static PFNKTXITERCB

Returns:

the new PFNKTXITERCB
create(long functionPointer)

Creates a PFNKTXITERCB instance from the specified function pointer.

public static PFNKTXITERCB
create(PFNKTXITERCBI instance)

Creates a PFNKTXITERCB instance that delegates to the specified PFNKTXITERCBI instance.

public static PFNKTXITERCB
createSafe(long functionPointer)

Like create, but returns null if functionPointer is NULL.

Inherited from org.lwjgl.system.Callback:
addressequalsfreefreegetgetSafehashCodetoString

Constructor Detail

PFNKTXITERCBback to summary
protected PFNKTXITERCB()
PFNKTXITERCBback to summary
pack-priv PFNKTXITERCB(long functionPointer)

Method Detail

createback to summary
public static PFNKTXITERCB create(long functionPointer)

Creates a PFNKTXITERCB instance from the specified function pointer.

Returns:PFNKTXITERCB

the new PFNKTXITERCB

createback to summary
public static PFNKTXITERCB create(PFNKTXITERCBI instance)

Creates a PFNKTXITERCB instance that delegates to the specified PFNKTXITERCBI instance.

createSafeback to summary
public static PFNKTXITERCB createSafe(long functionPointer)

Like create, but returns null if functionPointer is NULL.

Annotations
@Nullable
org.lwjgl.util.ktx back to summary

private final Class PFNKTXITERCB.Container

extends PFNKTXITERCB
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final PFNKTXITERCBI
delegate

Constructor Summary

AccessConstructor and Description
pack-priv
Container(long functionPointer, PFNKTXITERCBI delegate)

Method Summary

Modifier and TypeMethod and Description
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)

Implements org.lwjgl.util.ktx.PFNKTXITERCBI.invoke.

Signature of function called by the ktxTexture_Iterate* functions to receive image data.
Inherited from org.lwjgl.util.ktx.PFNKTXITERCB:
createcreatecreateSafe

Field Detail

delegateback to summary
private final PFNKTXITERCBI delegate

Constructor Detail

Containerback to summary
pack-priv Container(long functionPointer, PFNKTXITERCBI delegate)

Method Detail

invokeback to summary
public int invoke(int miplevel, int face, int width, int height, int depth, long faceLodSize, long pixels, long userdata)

Implements org.lwjgl.util.ktx.PFNKTXITERCBI.invoke.

Doc from org.lwjgl.util.ktx.PFNKTXITERCBI.invoke.

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
@Override