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

public Class OpusEncCallbacks

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

Callback functions for accessing the stream.

Layout


struct OpusEncCallbacks {
    ope_write_func write;
    ope_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
SIZEOF

The struct size in bytes.

public static final int
WRITE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
OpusEncCallbacks(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static OpusEncCallbacks
calloc()

Returns a new OpusEncCallbacks instance allocated with memCalloc.

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

Returns a new OpusEncCallbacks.Buffer instance allocated with memCalloc.

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

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

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

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

public OPECloseFunc
close$()

callback for closing the stream

public OpusEncCallbacks
close$(OPECloseFuncI value)

Sets the specified value to the close$ field.

protected OpusEncCallbacks
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 OpusEncCallbacks
create()

Returns a new OpusEncCallbacks instance allocated with BufferUtils.

public static OpusEncCallbacks
create(long address)

Returns a new OpusEncCallbacks instance for the specified memory address.

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

Returns a new OpusEncCallbacks.Buffer instance allocated with BufferUtils.

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

Create a OpusEncCallbacks.Buffer instance at the specified memory.

public static OpusEncCallbacks
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static OpusEncCallbacks
malloc()

Returns a new OpusEncCallbacks instance allocated with memAlloc.

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

Returns a new OpusEncCallbacks.Buffer instance allocated with memAlloc.

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

Returns a new OpusEncCallbacks instance allocated on the specified MemoryStack.

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

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

public static OPECloseFunc
nclose$(long struct)

Unsafe version of close$.

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

Unsafe version of close$.

public static OPEWriteFunc
nwrite(long struct)

Unsafe version of write.

public static void
nwrite(long struct, OPEWriteFuncI value)

Unsafe version of write.

public OpusEncCallbacks
set(OPEWriteFuncI write, OPECloseFuncI close$)

Initializes this struct with the specified values.

public OpusEncCallbacks

Returns:

this struct
set
(OpusEncCallbacks
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 static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

public OPEWriteFunc
write()

callback for writing to the stream

public OpusEncCallbacks
write(OPEWriteFuncI value)

Sets the specified value to the write field.

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.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

WRITEback to summary
public static final int WRITE

The struct member offsets.

Constructor Detail

OpusEncCallbacksback to summary
protected OpusEncCallbacks(long address, ByteBuffer container)
OpusEncCallbacksback to summary
public OpusEncCallbacks(ByteBuffer container)

Creates a OpusEncCallbacks 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 OpusEncCallbacks calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static OpusEncCallbacks calloc(MemoryStack stack)

Returns a new OpusEncCallbacks 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 OpusEncCallbacks.Buffer calloc(int capacity, MemoryStack stack)

Returns a new OpusEncCallbacks.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 OPECloseFunc close$()

callback for closing the stream

Annotations
@NativeType:ope_close_func
close$back to summary
public OpusEncCallbacks close$(OPECloseFuncI value)

Sets the specified value to the close$ field.

createback to summary
protected OpusEncCallbacks 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 OpusEncCallbacks create()

Returns a new OpusEncCallbacks instance allocated with BufferUtils.

createback to summary
public static OpusEncCallbacks create(long address)

Returns a new OpusEncCallbacks instance for the specified memory address.

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

Returns a new OpusEncCallbacks.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a OpusEncCallbacks.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static OpusEncCallbacks createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static OpusEncCallbacks malloc(MemoryStack stack)

Returns a new OpusEncCallbacks instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new OpusEncCallbacks.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 OPECloseFunc nclose$(long struct)

Unsafe version of close$.

nclose$back to summary
public static void nclose$(long struct, OPECloseFuncI value)

Unsafe version of close$.

nwriteback to summary
public static OPEWriteFunc nwrite(long struct)

Unsafe version of write.

nwriteback to summary
public static void nwrite(long struct, OPEWriteFuncI value)

Unsafe version of write.

setback to summary
public OpusEncCallbacks set(OPEWriteFuncI write, OPECloseFuncI close$)

Initializes this struct with the specified values.

setback to summary
public OpusEncCallbacks set(OpusEncCallbacks src)

Copies the specified struct data to this struct.

Parameters
src:OpusEncCallbacks

the source struct

Returns:OpusEncCallbacks

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
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

writeback to summary
public OPEWriteFunc write()

callback for writing to the stream

Annotations
@NativeType:ope_write_func
writeback to summary
public OpusEncCallbacks write(OPEWriteFuncI value)

Sets the specified value to the write field.

org.lwjgl.util.opus back to summary

public Class OpusEncCallbacks.Buffer

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

An array of OpusEncCallbacks structs.

Field Summary

Modifier and TypeField and Description
private static final OpusEncCallbacks

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new OpusEncCallbacks.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 OPECloseFunc

Returns:

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

public OpusEncCallbacks.Buffer
close$(OPECloseFuncI value)

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

protected OpusEncCallbacks
protected OpusEncCallbacks.Buffer
public OPEWriteFunc

Returns:

the value of the OpusEncCallbacks#write field.
write
()

public OpusEncCallbacks.Buffer
write(OPEWriteFuncI value)

Sets the specified value to the OpusEncCallbacks#write field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final OpusEncCallbacks ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new OpusEncCallbacks.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 OpusEncCallbacks#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 OPECloseFunc close$()
Returns:OPECloseFunc

the value of the OpusEncCallbacks#close$ field.

Annotations
@NativeType:ope_close_func
close$back to summary
public OpusEncCallbacks.Buffer close$(OPECloseFuncI value)

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

getElementFactoryback to summary
protected OpusEncCallbacks getElementFactory()

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

Annotations
@Override
selfback to summary
protected OpusEncCallbacks.Buffer self()

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

Annotations
@Override
writeback to summary
public OPEWriteFunc write()
Returns:OPEWriteFunc

the value of the OpusEncCallbacks#write field.

Annotations
@NativeType:ope_write_func
writeback to summary
public OpusEncCallbacks.Buffer write(OPEWriteFuncI value)

Sets the specified value to the OpusEncCallbacks#write field.