Package org.lwjgl.fmod

Class FMOD_CODEC_STATE

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<FMOD_CODEC_STATE>

org.lwjgl.fmod.FMOD_CODEC_STATE

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class FMOD_CODEC_STATE
extends Struct<FMOD_CODEC_STATE>
implements NativeResource

 struct FMOD_CODEC_STATE {
     void * plugindata;
     {@link FMOD_CODEC_WAVEFORMAT struct FMOD_CODEC_WAVEFORMAT} * waveformat;
     {@link FMOD_CODEC_STATE_FUNCTIONS FMOD_CODEC_STATE_FUNCTIONS} * functions;
     int numsubsounds;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FMOD_CODEC_STATE.Buffer	An array of FMOD_CODEC_STATE 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	FUNCTIONS	The struct member offsets.
static final int	NUMSUBSOUNDS	The struct member offsets.
static final int	PLUGINDATA	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	WAVEFORMAT	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
FMOD_CODEC_STATE(ByteBuffer container)	Creates a FMOD_CODEC_STATE instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static FMOD_CODEC_STATE	calloc()	Returns a new FMOD_CODEC_STATE instance allocated with memCalloc.
static FMOD_CODEC_STATE.Buffer	calloc(int capacity)	Returns a new FMOD_CODEC_STATE.Buffer instance allocated with memCalloc.
static FMOD_CODEC_STATE.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new FMOD_CODEC_STATE.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static FMOD_CODEC_STATE	calloc(MemoryStack stack)	Returns a new FMOD_CODEC_STATE instance allocated on the specified MemoryStack and initializes all its bits to zero.
static FMOD_CODEC_STATE	create()	Returns a new FMOD_CODEC_STATE instance allocated with BufferUtils.
static FMOD_CODEC_STATE.Buffer	create(int capacity)	Returns a new FMOD_CODEC_STATE.Buffer instance allocated with BufferUtils.
static FMOD_CODEC_STATE	create(long address)	Returns a new FMOD_CODEC_STATE instance for the specified memory address.
static FMOD_CODEC_STATE.Buffer	create(long address, int capacity)	Create a FMOD_CODEC_STATE.Buffer instance at the specified memory.
static @Nullable FMOD_CODEC_STATE	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable FMOD_CODEC_STATE.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
FMOD_CODEC_STATE_FUNCTIONS	functions()
FMOD_CODEC_STATE	functions(FMOD_CODEC_STATE_FUNCTIONS value)	Sets the address of the specified FMOD_CODEC_STATE_FUNCTIONS to the functions field.
static FMOD_CODEC_STATE	malloc()	Returns a new FMOD_CODEC_STATE instance allocated with memAlloc.
static FMOD_CODEC_STATE.Buffer	malloc(int capacity)	Returns a new FMOD_CODEC_STATE.Buffer instance allocated with memAlloc.
static FMOD_CODEC_STATE.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new FMOD_CODEC_STATE.Buffer instance allocated on the specified MemoryStack.
static FMOD_CODEC_STATE	malloc(MemoryStack stack)	Returns a new FMOD_CODEC_STATE instance allocated on the specified MemoryStack.
static FMOD_CODEC_STATE_FUNCTIONS	nfunctions(long struct)	Unsafe version of functions().
static void	nfunctions(long struct, FMOD_CODEC_STATE_FUNCTIONS value)	Unsafe version of functions.
static int	nnumsubsounds(long struct)	Unsafe version of numsubsounds().
static void	nnumsubsounds(long struct, int value)	Unsafe version of numsubsounds.
static ByteBuffer	nplugindata(long struct, int capacity)	Unsafe version of plugindata.
static void	nplugindata(long struct, ByteBuffer value)	Unsafe version of plugindata.
int	numsubsounds()
FMOD_CODEC_STATE	numsubsounds(int value)	Sets the specified value to the numsubsounds field.
static FMOD_CODEC_WAVEFORMAT	nwaveformat(long struct)	Unsafe version of waveformat().
static void	nwaveformat(long struct, FMOD_CODEC_WAVEFORMAT value)	Unsafe version of waveformat.
ByteBuffer	plugindata(int capacity)
FMOD_CODEC_STATE	plugindata(ByteBuffer value)	Sets the address of the specified ByteBuffer to the plugindata field.
FMOD_CODEC_STATE	set(ByteBuffer plugindata, FMOD_CODEC_WAVEFORMAT waveformat, FMOD_CODEC_STATE_FUNCTIONS functions, int numsubsounds)	Initializes this struct with the specified values.
FMOD_CODEC_STATE	set(FMOD_CODEC_STATE src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
static void	validate(long struct)	Validates pointer members that should not be NULL.
FMOD_CODEC_WAVEFORMAT	waveformat()
FMOD_CODEC_STATE	waveformat(FMOD_CODEC_WAVEFORMAT value)	Sets the address of the specified FMOD_CODEC_WAVEFORMAT to the waveformat field.

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.

PLUGINDATA

public static final int PLUGINDATA

The struct member offsets.

WAVEFORMAT

public static final int WAVEFORMAT

The struct member offsets.

FUNCTIONS

public static final int FUNCTIONS

The struct member offsets.

NUMSUBSOUNDS

public static final int NUMSUBSOUNDS

The struct member offsets.

Constructor Details

FMOD_CODEC_STATE

public FMOD_CODEC_STATE(ByteBuffer container)

Creates a FMOD_CODEC_STATE 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<FMOD_CODEC_STATE>

plugindata

public ByteBuffer plugindata(int capacity)

Returns:

a ByteBuffer view of the data pointed to by the plugindata field.

waveformat

public FMOD_CODEC_WAVEFORMAT waveformat()

Returns:

a FMOD_CODEC_WAVEFORMAT view of the struct pointed to by the waveformat field.

functions

public FMOD_CODEC_STATE_FUNCTIONS functions()

Returns:

a FMOD_CODEC_STATE_FUNCTIONS view of the struct pointed to by the functions field.

numsubsounds

public int numsubsounds()

Returns:

the value of the numsubsounds field.

plugindata

public FMOD_CODEC_STATE plugindata(ByteBuffer value)

Sets the address of the specified ByteBuffer to the plugindata field.

waveformat

public FMOD_CODEC_STATE waveformat(FMOD_CODEC_WAVEFORMAT value)

Sets the address of the specified FMOD_CODEC_WAVEFORMAT to the waveformat field.

functions

public FMOD_CODEC_STATE functions(FMOD_CODEC_STATE_FUNCTIONS value)

Sets the address of the specified FMOD_CODEC_STATE_FUNCTIONS to the functions field.

numsubsounds

public FMOD_CODEC_STATE numsubsounds(int value)

Sets the specified value to the numsubsounds field.

set

public FMOD_CODEC_STATE set(ByteBuffer plugindata,
 FMOD_CODEC_WAVEFORMAT waveformat,
 FMOD_CODEC_STATE_FUNCTIONS functions,
 int numsubsounds)

Initializes this struct with the specified values.

set

public FMOD_CODEC_STATE set(FMOD_CODEC_STATE src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static FMOD_CODEC_STATE malloc()

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

calloc

public static FMOD_CODEC_STATE calloc()

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

create

public static FMOD_CODEC_STATE create()

Returns a new FMOD_CODEC_STATE instance allocated with BufferUtils.

create

public static FMOD_CODEC_STATE create(long address)

Returns a new FMOD_CODEC_STATE instance for the specified memory address.

createSafe

public static @Nullable FMOD_CODEC_STATE createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static FMOD_CODEC_STATE.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static FMOD_CODEC_STATE.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static FMOD_CODEC_STATE.Buffer create(int capacity)

Returns a new FMOD_CODEC_STATE.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a FMOD_CODEC_STATE.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static FMOD_CODEC_STATE malloc(MemoryStack stack)

Returns a new FMOD_CODEC_STATE instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static FMOD_CODEC_STATE calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static FMOD_CODEC_STATE.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new FMOD_CODEC_STATE.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

nplugindata

public static ByteBuffer nplugindata(long struct,
 int capacity)

Unsafe version of plugindata.

nwaveformat

public static FMOD_CODEC_WAVEFORMAT nwaveformat(long struct)

Unsafe version of waveformat().

nfunctions

public static FMOD_CODEC_STATE_FUNCTIONS nfunctions(long struct)

Unsafe version of functions().

nnumsubsounds

public static int nnumsubsounds(long struct)

Unsafe version of numsubsounds().

nplugindata

public static void nplugindata(long struct,
 ByteBuffer value)

Unsafe version of plugindata.

nwaveformat

public static void nwaveformat(long struct,
 FMOD_CODEC_WAVEFORMAT value)

Unsafe version of waveformat.

nfunctions

public static void nfunctions(long struct,
 FMOD_CODEC_STATE_FUNCTIONS value)

Unsafe version of functions.

nnumsubsounds

public static void nnumsubsounds(long struct,
 int value)

Unsafe version of numsubsounds.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate