Top Description Fields Methods
org.lwjgl.bgfx

public Interface BGFXProfilerBeginI

extends CallbackI
Known Direct Implementers
org.lwjgl.bgfx.BGFXProfilerBegin
Annotations
@FunctionalInterface
@NativeType:void (*) (bgfx_callback_interface_t *, char const *, uint32_t, char const *, uint16_t)
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*

Profiler region begin.

Type


void (*invoke) (
    bgfx_callback_interface_t *_this,
    char const *_name,
    uint32_t _abgr,
    char const *_filePath,
    uint16_t _line
)

Field Summary

Modifier and TypeField and Description
public static final FFICIF

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
region name, contains dynamic string
_name
,
int
color of profiler region
_abgr
,
long
file path where profiler_begin was called
_filePath
,
short
line where profiler_begin was called
_line
)

Will be called when a profiler region begins.

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 _name, int _abgr, long _filePath, short _line)

Will be called when a profiler region begins.

Not thread safe and it can be called from any thread.

Parameters
_this:long

the callback interface

_name:long

region name, contains dynamic string

_abgr:int

color of profiler region

_filePath:long

file path where profiler_begin was called

_line:short

line where profiler_begin was called