Top Description Inners Fields Constructors Methods
org.lwjgl.util.opus

public Class OpusFileCallbacks

extends Struct<OpusFileCallbacks>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

The callbacks used to access non-FILE stream resources.

The function prototypes are basically the same as for the stdio functions fread(), fseek(), ftell(), and fclose(). The differences are that the FILE * arguments have been replaced with a void *, which is to be used as a pointer to whatever internal data these functions might need, that seek and tell take and return 64-bit offsets, and that seek must return -1 if the stream is unseekable.

Layout


struct OpusFileCallbacks {
    op_read_func read;
    op_seek_func seek;
    op_tell_func tell;
    op_close_func close;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CLOSE

The struct member offsets.

public static final int
READ

The struct member offsets.

public static final int
SEEK

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TELL

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
OpusFileCallbacks(long address, ByteBuffer container)

public
OpusFileCallbacks(ByteBuffer container)

Creates a OpusFileCallbacks instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static OpusFileCallbacks
calloc()

Returns a new OpusFileCallbacks instance allocated with memCalloc.

public static OpusFileCallbacks.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new OpusFileCallbacks.Buffer instance allocated with memCalloc.

public static OpusFileCallbacks
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new OpusFileCallbacks instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static OpusFileCallbacks.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new OpusFileCallbacks.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public OPCloseFunc
close$()

used to close the stream when the decoder is freed.

public OpusFileCallbacks
close$(OPCloseFuncI value)

Sets the specified value to the close$ field.

protected OpusFileCallbacks
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static OpusFileCallbacks
create()

Returns a new OpusFileCallbacks instance allocated with BufferUtils.

public static OpusFileCallbacks
create(long address)

Returns a new OpusFileCallbacks instance for the specified memory address.

public static OpusFileCallbacks.Buffer
create(int
the buffer capacity
capacity
)

Returns a new OpusFileCallbacks.Buffer instance allocated with BufferUtils.

public static OpusFileCallbacks.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a OpusFileCallbacks.Buffer instance at the specified memory.

public static OpusFileCallbacks
createSafe(long address)

Like create, but returns null if address is NULL.

public static OpusFileCallbacks.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static OpusFileCallbacks
malloc()

Returns a new OpusFileCallbacks instance allocated with memAlloc.

public static OpusFileCallbacks.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new OpusFileCallbacks.Buffer instance allocated with memAlloc.

public static OpusFileCallbacks
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new OpusFileCallbacks instance allocated on the specified MemoryStack.

public static OpusFileCallbacks.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new OpusFileCallbacks.Buffer instance allocated on the specified MemoryStack.

public static OPCloseFunc
nclose$(long struct)

Unsafe version of close$.

public static void
nclose$(long struct, OPCloseFuncI value)

Unsafe version of close$.

public static OPReadFunc
nread(long struct)

Unsafe version of read.

public static void
nread(long struct, OPReadFuncI value)

Unsafe version of read.

public static OPSeekFunc
nseek(long struct)

Unsafe version of seek.

public static void
nseek(long struct, OPSeekFuncI value)

Unsafe version of seek.

public static OPTellFunc
ntell(long struct)

Unsafe version of tell.

public static void
ntell(long struct, OPTellFuncI value)

Unsafe version of tell.

public OPReadFunc
read()

used to read data from the stream.

public OpusFileCallbacks
read(OPReadFuncI value)

Sets the specified value to the read field.

public OPSeekFunc
seek()

used to seek in the stream.

public OpusFileCallbacks
seek(OPSeekFuncI value)

Sets the specified value to the seek field.

public OpusFileCallbacks
set(OPReadFuncI read, OPSeekFuncI seek, OPTellFuncI tell, OPCloseFuncI close$)

Initializes this struct with the specified values.

public OpusFileCallbacks

Returns:

this struct
set
(OpusFileCallbacks
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public OPTellFunc
tell()

used to return the current read position in the stream.

public OpusFileCallbacks
tell(OPTellFuncI value)

Sets the specified value to the tell field.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

CLOSEback to summary
public static final int CLOSE

The struct member offsets.

READback to summary
public static final int READ

The struct member offsets.

SEEKback to summary
public static final int SEEK

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TELLback to summary
public static final int TELL

The struct member offsets.

Constructor Detail

OpusFileCallbacksback to summary
protected OpusFileCallbacks(long address, ByteBuffer container)
OpusFileCallbacksback to summary
public OpusFileCallbacks(ByteBuffer container)

Creates a OpusFileCallbacks instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Detail

callocback to summary
public static OpusFileCallbacks calloc()

Returns a new OpusFileCallbacks instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static OpusFileCallbacks.Buffer calloc(int capacity)

Returns a new OpusFileCallbacks.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static OpusFileCallbacks calloc(MemoryStack stack)

Returns a new OpusFileCallbacks instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static OpusFileCallbacks.Buffer calloc(int capacity, MemoryStack stack)

Returns a new OpusFileCallbacks.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

close$back to summary
public OPCloseFunc close$()

used to close the stream when the decoder is freed. This may be NULL to leave the stream open.

Annotations
@Nullable
@NativeType:op_close_func
close$back to summary
public OpusFileCallbacks close$(OPCloseFuncI value)

Sets the specified value to the close$ field.

createback to summary
protected OpusFileCallbacks create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static OpusFileCallbacks create()

Returns a new OpusFileCallbacks instance allocated with BufferUtils.

createback to summary
public static OpusFileCallbacks create(long address)

Returns a new OpusFileCallbacks instance for the specified memory address.

createback to summary
public static OpusFileCallbacks.Buffer create(int capacity)

Returns a new OpusFileCallbacks.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static OpusFileCallbacks.Buffer create(long address, int capacity)

Create a OpusFileCallbacks.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static OpusFileCallbacks createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static OpusFileCallbacks.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static OpusFileCallbacks malloc()

Returns a new OpusFileCallbacks instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static OpusFileCallbacks.Buffer malloc(int capacity)

Returns a new OpusFileCallbacks.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static OpusFileCallbacks malloc(MemoryStack stack)

Returns a new OpusFileCallbacks instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static OpusFileCallbacks.Buffer malloc(int capacity, MemoryStack stack)

Returns a new OpusFileCallbacks.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nclose$back to summary
public static OPCloseFunc nclose$(long struct)

Unsafe version of close$.

Annotations
@Nullable
nclose$back to summary
public static void nclose$(long struct, OPCloseFuncI value)

Unsafe version of close$.

nreadback to summary
public static OPReadFunc nread(long struct)

Unsafe version of read.

nreadback to summary
public static void nread(long struct, OPReadFuncI value)

Unsafe version of read.

nseekback to summary
public static OPSeekFunc nseek(long struct)

Unsafe version of seek.

Annotations
@Nullable
nseekback to summary
public static void nseek(long struct, OPSeekFuncI value)

Unsafe version of seek.

ntellback to summary
public static OPTellFunc ntell(long struct)

Unsafe version of tell.

Annotations
@Nullable
ntellback to summary
public static void ntell(long struct, OPTellFuncI value)

Unsafe version of tell.

readback to summary
public OPReadFunc read()

used to read data from the stream. This must not be NULL.

Annotations
@NativeType:op_read_func
readback to summary
public OpusFileCallbacks read(OPReadFuncI value)

Sets the specified value to the read field.

seekback to summary
public OPSeekFunc seek()

used to seek in the stream. This may be NULL if seeking is not implemented.

Annotations
@Nullable
@NativeType:op_seek_func
seekback to summary
public OpusFileCallbacks seek(OPSeekFuncI value)

Sets the specified value to the seek field.

setback to summary
public OpusFileCallbacks set(OPReadFuncI read, OPSeekFuncI seek, OPTellFuncI tell, OPCloseFuncI close$)

Initializes this struct with the specified values.

setback to summary
public OpusFileCallbacks set(OpusFileCallbacks src)

Copies the specified struct data to this struct.

Parameters
src:OpusFileCallbacks

the source struct

Returns:OpusFileCallbacks

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
tellback to summary
public OPTellFunc tell()

used to return the current read position in the stream. This may be NULL if seeking is not implemented.

Annotations
@Nullable
@NativeType:op_tell_func
tellback to summary
public OpusFileCallbacks tell(OPTellFuncI value)

Sets the specified value to the tell field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.util.opus back to summary

public Class OpusFileCallbacks.Buffer

extends StructBuffer<OpusFileCallbacks, OpusFileCallbacks.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of OpusFileCallbacks structs.

Field Summary

Modifier and TypeField and Description
private static final OpusFileCallbacks

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new OpusFileCallbacks.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public OPCloseFunc

Returns:

the value of the OpusFileCallbacks#close$ field.
close$
()

public OpusFileCallbacks.Buffer
close$(OPCloseFuncI value)

Sets the specified value to the OpusFileCallbacks#close$ field.

protected OpusFileCallbacks
public OPReadFunc

Returns:

the value of the OpusFileCallbacks#read field.
read
()

public OpusFileCallbacks.Buffer
read(OPReadFuncI value)

Sets the specified value to the OpusFileCallbacks#read field.

public OPSeekFunc

Returns:

the value of the OpusFileCallbacks#seek field.
seek
()

public OpusFileCallbacks.Buffer
seek(OPSeekFuncI value)

Sets the specified value to the OpusFileCallbacks#seek field.

protected OpusFileCallbacks.Buffer
public OPTellFunc

Returns:

the value of the OpusFileCallbacks#tell field.
tell
()

public OpusFileCallbacks.Buffer
tell(OPTellFuncI value)

Sets the specified value to the OpusFileCallbacks#tell field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final OpusFileCallbacks ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new OpusFileCallbacks.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by OpusFileCallbacks#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

close$back to summary
public OPCloseFunc close$()
Returns:OPCloseFunc

the value of the OpusFileCallbacks#close$ field.

Annotations
@Nullable
@NativeType:op_close_func
close$back to summary
public OpusFileCallbacks.Buffer close$(OPCloseFuncI value)

Sets the specified value to the OpusFileCallbacks#close$ field.

getElementFactoryback to summary
protected OpusFileCallbacks getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
readback to summary
public OPReadFunc read()
Returns:OPReadFunc

the value of the OpusFileCallbacks#read field.

Annotations
@NativeType:op_read_func
readback to summary
public OpusFileCallbacks.Buffer read(OPReadFuncI value)

Sets the specified value to the OpusFileCallbacks#read field.

seekback to summary
public OPSeekFunc seek()
Returns:OPSeekFunc

the value of the OpusFileCallbacks#seek field.

Annotations
@Nullable
@NativeType:op_seek_func
seekback to summary
public OpusFileCallbacks.Buffer seek(OPSeekFuncI value)

Sets the specified value to the OpusFileCallbacks#seek field.

selfback to summary
protected OpusFileCallbacks.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
tellback to summary
public OPTellFunc tell()
Returns:OPTellFunc

the value of the OpusFileCallbacks#tell field.

Annotations
@Nullable
@NativeType:op_tell_func
tellback to summary
public OpusFileCallbacks.Buffer tell(OPTellFuncI value)

Sets the specified value to the OpusFileCallbacks#tell field.