Top Description Fields Methods
org.lwjgl.bgfx

public Interface BGFXScreenShotCallbackI

extends CallbackI
Known Direct Implementers
org.lwjgl.bgfx.BGFXScreenShotCallback
Annotations
@FunctionalInterface
@NativeType:void (*) (bgfx_callback_interface_t *, char const *, uint32_t, uint32_t, uint32_t, void const *, uint32_t, bool)
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*
Screenshot captured. Screenshot format is always 4-byte BGRA.

Type


void (*invoke) (
    bgfx_callback_interface_t *_this,
    char const *_filePath,
    uint32_t _width,
    uint32_t _height,
    uint32_t _pitch,
    void const *_data,
    uint32_t _size,
    bool _yflip
)

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 void
invoke(long
the callback interface
_this, long
file path
_filePath, int
image width
_width, int
image height
_height, int
number of bytes to skip between the start of each horizontal line of the image
_pitch, long
image data
_data, int
image size
_size, boolean
if true, image origin is bottom left
_yflip)

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 void invoke(long _this, long _filePath, int _width, int _height, int _pitch, long _data, int _size, boolean _yflip)
Parameters
_this:long

the callback interface

_filePath:long

file path

_width:int

image width

_height:int

image height

_pitch:int

number of bytes to skip between the start of each horizontal line of the image

_data:long

image data

_size:int

image size

_yflip:boolean

if true, image origin is bottom left