Top Description Fields Methods
org.lwjgl.util.opus

public Interface OPReadFuncI

extends CallbackI
Known Direct Implementers
org.lwjgl.util.opus.OPReadFunc
Annotations
@FunctionalInterface
@NativeType:op_read_func
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*
Instances of this interface may be set to OpusFileCallbacks.

Type


int (*invoke) (
    void *_stream,
    unsigned char *_ptr,
    int _nbytes
)

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 int

Returns:

the number of bytes successfully read, or a negative value on error
invoke(long
the stream to read from
_stream, long
the buffer to store the data in
_ptr, int
the maximum number of bytes to read. This function may return fewer, though it will not return zero unless it reaches end-of-file.
_nbytes)

Reads up to _nbytes bytes of data from _stream.

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 int invoke(long _stream, long _ptr, int _nbytes)

Reads up to _nbytes bytes of data from _stream.

Parameters
_stream:long

the stream to read from

_ptr:long

the buffer to store the data in

_nbytes:int

the maximum number of bytes to read. This function may return fewer, though it will not return zero unless it reaches end-of-file.

Returns:int

the number of bytes successfully read, or a negative value on error