Top Description Fields Methods
org.lwjgl.openal

public Interface SOFTCallbackBufferTypeI

extends CallbackI
Known Direct Implementers
org.lwjgl.openal.SOFTCallbackBufferType
Annotations
@FunctionalInterface
@NativeType:ALBUFFERCALLBACKTYPESOFT
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*

Type


void * (*invoke) (
    ALvoid *userptr,
    ALvoid *sampledata,
    ALsizei numbytes
)

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 long

Returns:

the number of bytes actually written, which must be equal to or less than numbytes.

If the return value is less than numbytes, it's treated as the end of the buffer and the source will play any complete samples before stopping.

invoke
(long
the same pointer provided to BufferCallbackSOFT
userptr
,
long
a pointer to the sample data buffer that should be filled in by the function
sampledata
,
int
the number of bytes needed to fill the sample data buffer for this invocation.

Guaranteed to be greater than 0 and a multiple of the frame size for the format.

numbytes
)

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 long invoke(long userptr, long sampledata, int numbytes)
Parameters
userptr:long

the same pointer provided to BufferCallbackSOFT

sampledata:long

a pointer to the sample data buffer that should be filled in by the function

numbytes:int

the number of bytes needed to fill the sample data buffer for this invocation.

Guaranteed to be greater than 0 and a multiple of the frame size for the format.

Returns:long

the number of bytes actually written, which must be equal to or less than numbytes.

If the return value is less than numbytes, it's treated as the end of the buffer and the source will play any complete samples before stopping.

Annotations
@NativeType:void *