Package org.lwjgl.util.opus

Class OpusFileCallbacks

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<OpusFileCallbacks>

org.lwjgl.util.opus.OpusFileCallbacks

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class OpusFileCallbacks
extends Struct<OpusFileCallbacks>
implements NativeResource

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpusFileCallbacks.Buffer	An array of OpusFileCallbacks structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CLOSE	The struct member offsets.
static final int	READ	The struct member offsets.
static final int	SEEK	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TELL	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
OpusFileCallbacks(ByteBuffer container)	Creates a OpusFileCallbacks instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static OpusFileCallbacks	calloc()	Returns a new OpusFileCallbacks instance allocated with memCalloc.
static OpusFileCallbacks.Buffer	calloc(int capacity)	Returns a new OpusFileCallbacks.Buffer instance allocated with memCalloc.
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.
static OpusFileCallbacks	calloc(MemoryStack stack)	Returns a new OpusFileCallbacks instance allocated on the specified MemoryStack and initializes all its bits to zero.
@Nullable OPCloseFunc	close$()
OpusFileCallbacks	close$(@Nullable OPCloseFuncI value)	Sets the specified value to the close field.
static OpusFileCallbacks	create()	Returns a new OpusFileCallbacks instance allocated with BufferUtils.
static OpusFileCallbacks.Buffer	create(int capacity)	Returns a new OpusFileCallbacks.Buffer instance allocated with BufferUtils.
static OpusFileCallbacks	create(long address)	Returns a new OpusFileCallbacks instance for the specified memory address.
static OpusFileCallbacks.Buffer	create(long address, int capacity)	Create a OpusFileCallbacks.Buffer instance at the specified memory.
static @Nullable OpusFileCallbacks	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable OpusFileCallbacks.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static OpusFileCallbacks	malloc()	Returns a new OpusFileCallbacks instance allocated with memAlloc.
static OpusFileCallbacks.Buffer	malloc(int capacity)	Returns a new OpusFileCallbacks.Buffer instance allocated with memAlloc.
static OpusFileCallbacks.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new OpusFileCallbacks.Buffer instance allocated on the specified MemoryStack.
static OpusFileCallbacks	malloc(MemoryStack stack)	Returns a new OpusFileCallbacks instance allocated on the specified MemoryStack.
static @Nullable OPCloseFunc	nclose$(long struct)	Unsafe version of close$().
static void	nclose$(long struct, @Nullable OPCloseFuncI value)	Unsafe version of close$.
static OPReadFunc	nread(long struct)	Unsafe version of read().
static void	nread(long struct, OPReadFuncI value)	Unsafe version of read.
static @Nullable OPSeekFunc	nseek(long struct)	Unsafe version of seek().
static void	nseek(long struct, @Nullable OPSeekFuncI value)	Unsafe version of seek.
static @Nullable OPTellFunc	ntell(long struct)	Unsafe version of tell().
static void	ntell(long struct, @Nullable OPTellFuncI value)	Unsafe version of tell.
OPReadFunc	read()
OpusFileCallbacks	read(OPReadFuncI value)	Sets the specified value to the read field.
@Nullable OPSeekFunc	seek()
OpusFileCallbacks	seek(@Nullable OPSeekFuncI value)	Sets the specified value to the seek field.
OpusFileCallbacks	set(OPReadFuncI read, OPSeekFuncI seek, OPTellFuncI tell, OPCloseFuncI close$)	Initializes this struct with the specified values.
OpusFileCallbacks	set(OpusFileCallbacks src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
@Nullable OPTellFunc	tell()
OpusFileCallbacks	tell(@Nullable OPTellFuncI value)	Sets the specified value to the tell field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

READ

public static final int READ

The struct member offsets.

SEEK

public static final int SEEK

The struct member offsets.

TELL

public static final int TELL

The struct member offsets.

CLOSE

public static final int CLOSE

The struct member offsets.

Constructor Details

OpusFileCallbacks

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<OpusFileCallbacks>

read

public OPReadFunc read()

Returns:

the value of the read field.

seek

public @Nullable OPSeekFunc seek()

Returns:

the value of the seek field.

tell

public @Nullable OPTellFunc tell()

Returns:

the value of the tell field.

close$

public @Nullable OPCloseFunc close$()

Returns:

the value of the close field.

read

public OpusFileCallbacks read(OPReadFuncI value)

Sets the specified value to the read field.

seek

public OpusFileCallbacks seek(@Nullable OPSeekFuncI value)

Sets the specified value to the seek field.

tell

public OpusFileCallbacks tell(@Nullable OPTellFuncI value)

Sets the specified value to the tell field.

close$

public OpusFileCallbacks close$(@Nullable OPCloseFuncI value)

Sets the specified value to the close field.

set

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

Initializes this struct with the specified values.

set

public OpusFileCallbacks set(OpusFileCallbacks src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static OpusFileCallbacks malloc()

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

calloc

public static OpusFileCallbacks calloc()

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

create

public static OpusFileCallbacks create()

Returns a new OpusFileCallbacks instance allocated with BufferUtils.

create

public static OpusFileCallbacks create(long address)

Returns a new OpusFileCallbacks instance for the specified memory address.

createSafe

public static @Nullable OpusFileCallbacks createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static OpusFileCallbacks.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static OpusFileCallbacks.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static OpusFileCallbacks.Buffer create(int capacity)

Returns a new OpusFileCallbacks.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a OpusFileCallbacks.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static OpusFileCallbacks malloc(MemoryStack stack)

Returns a new OpusFileCallbacks instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

nread

public static OPReadFunc nread(long struct)

Unsafe version of read().

nseek

public static @Nullable OPSeekFunc nseek(long struct)

Unsafe version of seek().

ntell

public static @Nullable OPTellFunc ntell(long struct)

Unsafe version of tell().

nclose$

public static @Nullable OPCloseFunc nclose$(long struct)

Unsafe version of close$().

nread

public static void nread(long struct,
 OPReadFuncI value)

Unsafe version of read.

nseek

public static void nseek(long struct,
 @Nullable OPSeekFuncI value)

Unsafe version of seek.

ntell

public static void ntell(long struct,
 @Nullable OPTellFuncI value)

Unsafe version of tell.

nclose$

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

Unsafe version of close$.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate