Top Description Inners Fields Constructors Methods
org.lwjgl.fmod

public Class FMOD_CODEC_STATE

extends Struct<FMOD_CODEC_STATE>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct FMOD_CODEC_STATE
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


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

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
FUNCTIONS

The struct member offsets.

public static final int
NUMSUBSOUNDS

The struct member offsets.

public static final int
PLUGINDATA

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
WAVEFORMAT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
FMOD_CODEC_STATE(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static FMOD_CODEC_STATE
calloc()

Returns a new FMOD_CODEC_STATE instance allocated with memCalloc.

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

Returns a new FMOD_CODEC_STATE.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new FMOD_CODEC_STATE instance allocated with BufferUtils.

public static FMOD_CODEC_STATE
create(long address)

Returns a new FMOD_CODEC_STATE instance for the specified memory address.

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

Returns a new FMOD_CODEC_STATE.Buffer instance allocated with BufferUtils.

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

Create a FMOD_CODEC_STATE.Buffer instance at the specified memory.

public static FMOD_CODEC_STATE
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public FMOD_CODEC_STATE_FUNCTIONS

Returns:

a FMOD_CODEC_STATE_FUNCTIONS view of the struct pointed to by the functions 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.

public static FMOD_CODEC_STATE
malloc()

Returns a new FMOD_CODEC_STATE instance allocated with memAlloc.

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

Returns a new FMOD_CODEC_STATE.Buffer instance allocated with memAlloc.

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

Returns a new FMOD_CODEC_STATE instance allocated on the specified MemoryStack.

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

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

public static FMOD_CODEC_STATE_FUNCTIONS
nfunctions(long struct)

Unsafe version of functions.

public static void
nfunctions(long struct, FMOD_CODEC_STATE_FUNCTIONS value)

Unsafe version of functions.

public static int
nnumsubsounds(long struct)

Unsafe version of numsubsounds.

public static void
nnumsubsounds(long struct, int value)

Unsafe version of numsubsounds.

public static ByteBuffer
nplugindata(long struct, int capacity)

Unsafe version of plugindata.

public static void
nplugindata(long struct, ByteBuffer value)

Unsafe version of plugindata.

public int

Returns:

the value of the numsubsounds field.
numsubsounds
()

public FMOD_CODEC_STATE
numsubsounds(int value)

Sets the specified value to the numsubsounds field.

public static FMOD_CODEC_WAVEFORMAT
nwaveformat(long struct)

Unsafe version of waveformat.

public static void
nwaveformat(long struct, FMOD_CODEC_WAVEFORMAT value)

Unsafe version of waveformat.

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the plugindata field.
plugindata
(int
the number of elements in the returned buffer
capacity
)

public FMOD_CODEC_STATE
plugindata(ByteBuffer value)

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

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.

public FMOD_CODEC_STATE

Returns:

this struct
set
(FMOD_CODEC_STATE
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 FMOD_CODEC_WAVEFORMAT

Returns:

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

public FMOD_CODEC_STATE
waveformat(FMOD_CODEC_WAVEFORMAT value)

Sets the address of the specified FMOD_CODEC_WAVEFORMAT to the waveformat 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.

FUNCTIONSback to summary
public static final int FUNCTIONS

The struct member offsets.

NUMSUBSOUNDSback to summary
public static final int NUMSUBSOUNDS

The struct member offsets.

PLUGINDATAback to summary
public static final int PLUGINDATA

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

WAVEFORMATback to summary
public static final int WAVEFORMAT

The struct member offsets.

Constructor Detail

FMOD_CODEC_STATEback to summary
protected FMOD_CODEC_STATE(long address, ByteBuffer container)
FMOD_CODEC_STATEback to summary
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 Detail

callocback to summary
public static FMOD_CODEC_STATE calloc()

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

callocback to summary
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:int

the buffer capacity

callocback to summary
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:MemoryStack

the stack from which to allocate

callocback to summary
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:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

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

Returns a new FMOD_CODEC_STATE instance allocated with BufferUtils.

createback to summary
public static FMOD_CODEC_STATE create(long address)

Returns a new FMOD_CODEC_STATE instance for the specified memory address.

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

Returns a new FMOD_CODEC_STATE.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a FMOD_CODEC_STATE.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static FMOD_CODEC_STATE createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
functionsback to summary
public FMOD_CODEC_STATE_FUNCTIONS functions()
Returns:FMOD_CODEC_STATE_FUNCTIONS

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

Annotations
@NativeType:FMOD_CODEC_STATE_FUNCTIONS *
functionsback to summary
public FMOD_CODEC_STATE functions(FMOD_CODEC_STATE_FUNCTIONS value)

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

mallocback to summary
public static FMOD_CODEC_STATE malloc()

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

mallocback to summary
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:int

the buffer capacity

mallocback to summary
public static FMOD_CODEC_STATE malloc(MemoryStack stack)

Returns a new FMOD_CODEC_STATE instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
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:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nfunctionsback to summary
public static FMOD_CODEC_STATE_FUNCTIONS nfunctions(long struct)

Unsafe version of functions.

nfunctionsback to summary
public static void nfunctions(long struct, FMOD_CODEC_STATE_FUNCTIONS value)

Unsafe version of functions.

nnumsubsoundsback to summary
public static int nnumsubsounds(long struct)

Unsafe version of numsubsounds.

nnumsubsoundsback to summary
public static void nnumsubsounds(long struct, int value)

Unsafe version of numsubsounds.

nplugindataback to summary
public static ByteBuffer nplugindata(long struct, int capacity)

Unsafe version of plugindata.

nplugindataback to summary
public static void nplugindata(long struct, ByteBuffer value)

Unsafe version of plugindata.

numsubsoundsback to summary
public int numsubsounds()
Returns:int

the value of the numsubsounds field.

numsubsoundsback to summary
public FMOD_CODEC_STATE numsubsounds(int value)

Sets the specified value to the numsubsounds field.

nwaveformatback to summary
public static FMOD_CODEC_WAVEFORMAT nwaveformat(long struct)

Unsafe version of waveformat.

nwaveformatback to summary
public static void nwaveformat(long struct, FMOD_CODEC_WAVEFORMAT value)

Unsafe version of waveformat.

plugindataback to summary
public ByteBuffer plugindata(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

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

Annotations
@NativeType:void *
plugindataback to summary
public FMOD_CODEC_STATE plugindata(ByteBuffer value)

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

setback to summary
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.

setback to summary
public FMOD_CODEC_STATE set(FMOD_CODEC_STATE src)

Copies the specified struct data to this struct.

Parameters
src:FMOD_CODEC_STATE

the source struct

Returns:FMOD_CODEC_STATE

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

waveformatback to summary
public FMOD_CODEC_WAVEFORMAT waveformat()
Returns:FMOD_CODEC_WAVEFORMAT

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

Annotations
@NativeType:struct FMOD_CODEC_WAVEFORMAT *
waveformatback to summary
public FMOD_CODEC_STATE waveformat(FMOD_CODEC_WAVEFORMAT value)

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

org.lwjgl.fmod back to summary

public Class FMOD_CODEC_STATE.Buffer

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

An array of FMOD_CODEC_STATE structs.

Field Summary

Modifier and TypeField and Description
private static final FMOD_CODEC_STATE

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

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

public FMOD_CODEC_STATE.Buffer
functions(FMOD_CODEC_STATE_FUNCTIONS value)

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

protected FMOD_CODEC_STATE
public int

Returns:

the value of the numsubsounds field.
numsubsounds
()

public FMOD_CODEC_STATE.Buffer
numsubsounds(int value)

Sets the specified value to the numsubsounds field.

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the plugindata field.
plugindata
(int
the number of elements in the returned buffer
capacity
)

public FMOD_CODEC_STATE.Buffer
plugindata(ByteBuffer value)

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

protected FMOD_CODEC_STATE.Buffer
public FMOD_CODEC_WAVEFORMAT

Returns:

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

public FMOD_CODEC_STATE.Buffer
waveformat(FMOD_CODEC_WAVEFORMAT value)

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

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final FMOD_CODEC_STATE ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

functionsback to summary
public FMOD_CODEC_STATE_FUNCTIONS functions()
Returns:FMOD_CODEC_STATE_FUNCTIONS

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

Annotations
@NativeType:FMOD_CODEC_STATE_FUNCTIONS *
functionsback to summary
public FMOD_CODEC_STATE.Buffer functions(FMOD_CODEC_STATE_FUNCTIONS value)

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

getElementFactoryback to summary
protected FMOD_CODEC_STATE getElementFactory()

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

Annotations
@Override
numsubsoundsback to summary
public int numsubsounds()
Returns:int

the value of the numsubsounds field.

numsubsoundsback to summary
public FMOD_CODEC_STATE.Buffer numsubsounds(int value)

Sets the specified value to the numsubsounds field.

plugindataback to summary
public ByteBuffer plugindata(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

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

Annotations
@NativeType:void *
plugindataback to summary
public FMOD_CODEC_STATE.Buffer plugindata(ByteBuffer value)

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

selfback to summary
protected FMOD_CODEC_STATE.Buffer self()

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

Annotations
@Override
waveformatback to summary
public FMOD_CODEC_WAVEFORMAT waveformat()
Returns:FMOD_CODEC_WAVEFORMAT

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

Annotations
@NativeType:struct FMOD_CODEC_WAVEFORMAT *
waveformatback to summary
public FMOD_CODEC_STATE.Buffer waveformat(FMOD_CODEC_WAVEFORMAT value)

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