LWJGL 3.3.3 · org.lwjgl.system.rpmalloc.RPMemoryMapCallbackI

Modifier and Type	Field and Description
public static final FFICIF	CIF

Method Summary

Modifier and Type	Method 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 long	invoke(long the number of bytes to map size, long the alignment offset offset) Map memory pages for the given number of bytes.

Inherited from org.lwjgl.system.CallbackI:: address

CIF	back to summary
public static final FFICIF CIF

Method Detail

callback back to summary

callback	back 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

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

getCallInterface	back 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

getCallInterface

back 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

invoke back to summary

invoke	back to summary
public long invoke(long size, long offset) Map memory pages for the given number of bytes. The returned address MUST be aligned to the rpmalloc span size, which will always be a power of two. Optionally the function can store an alignment offset in the offset variable in case it performs alignment and the returned pointer is offset from the actual start of the memory region due to this alignment. The alignment offset will be passed to the memory unmap function. The alignment offset MUST NOT be larger than 65535 (storable in an `uint16_t`), if it is you must use natural alignment to shift it into 16 bits. If you set a `memory_map` function, you must also set a `memory_unmap` function or else the default implementation will be used for both. Parameters size:long the number of bytes to map offset:long the alignment offset Annotations @NativeType:void *

public long invoke(long size, long offset)

Map memory pages for the given number of bytes.

The returned address MUST be aligned to the rpmalloc span size, which will always be a power of two. Optionally the function can store an alignment offset in the offset variable in case it performs alignment and the returned pointer is offset from the actual start of the memory region due to this alignment. The alignment offset will be passed to the memory unmap function. The alignment offset MUST NOT be larger than 65535 (storable in an uint16_t), if it is you must use natural alignment to shift it into 16 bits.

If you set a memory_map function, you must also set a memory_unmap function or else the default implementation will be used for both.

Parameters

size:long: the number of bytes to map
offset:long: the alignment offset

Annotations

@NativeType:void *

public Interface RPMemoryMapCallbackI

Type

Field Summary

Method Summary

Field Detail

Method Detail