Top Description Inners Fields Constructors Methods
org.lwjgl.fmod

public Class FMOD_STUDIO_SOUND_INFO

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

Layout


struct FMOD_STUDIO_SOUND_INFO {
    char const * name_or_data;
    FMOD_MODE mode;
    FMOD_CREATESOUNDEXINFO exinfo;
    int subsoundindex;
}

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
EXINFO

The struct member offsets.

public static final int
MODE

The struct member offsets.

public static final int
NAME_OR_DATA

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SUBSOUNDINDEX

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
FMOD_STUDIO_SOUND_INFO(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static FMOD_STUDIO_SOUND_INFO
calloc()

Returns a new FMOD_STUDIO_SOUND_INFO instance allocated with memCalloc.

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

Returns a new FMOD_STUDIO_SOUND_INFO.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new FMOD_STUDIO_SOUND_INFO instance allocated with BufferUtils.

public static FMOD_STUDIO_SOUND_INFO
create(long address)

Returns a new FMOD_STUDIO_SOUND_INFO instance for the specified memory address.

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

Returns a new FMOD_STUDIO_SOUND_INFO.Buffer instance allocated with BufferUtils.

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

Create a FMOD_STUDIO_SOUND_INFO.Buffer instance at the specified memory.

public static FMOD_STUDIO_SOUND_INFO
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public FMOD_CREATESOUNDEXINFO

Returns:

a FMOD_CREATESOUNDEXINFO view of the exinfo field.
exinfo
()

public FMOD_STUDIO_SOUND_INFO
exinfo(FMOD_CREATESOUNDEXINFO value)

Copies the specified FMOD_CREATESOUNDEXINFO to the exinfo field.

public FMOD_STUDIO_SOUND_INFO
exinfo(Consumer<FMOD_CREATESOUNDEXINFO> consumer)

Passes the exinfo field to the specified Consumer.

public static FMOD_STUDIO_SOUND_INFO
malloc()

Returns a new FMOD_STUDIO_SOUND_INFO instance allocated with memAlloc.

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

Returns a new FMOD_STUDIO_SOUND_INFO.Buffer instance allocated with memAlloc.

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

Returns a new FMOD_STUDIO_SOUND_INFO instance allocated on the specified MemoryStack.

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

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

public int

Returns:

the value of the mode field.
mode
()

public FMOD_STUDIO_SOUND_INFO
mode(int value)

Sets the specified value to the mode field.

public ByteBuffer

Returns:

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

public FMOD_STUDIO_SOUND_INFO
name_or_data(ByteBuffer value)

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

public static FMOD_CREATESOUNDEXINFO
nexinfo(long struct)

Unsafe version of exinfo.

public static void
nexinfo(long struct, FMOD_CREATESOUNDEXINFO value)

Unsafe version of exinfo.

public static int
nmode(long struct)

Unsafe version of mode.

public static void
nmode(long struct, int value)

Unsafe version of mode.

public static ByteBuffer
nname_or_data(long struct, int capacity)

Unsafe version of name_or_data.

public static void
nname_or_data(long struct, ByteBuffer value)

Unsafe version of name_or_data.

public static int
nsubsoundindex(long struct)

Unsafe version of subsoundindex.

public static void
nsubsoundindex(long struct, int value)

Unsafe version of subsoundindex.

public FMOD_STUDIO_SOUND_INFO
set(ByteBuffer name_or_data, int mode, FMOD_CREATESOUNDEXINFO exinfo, int subsoundindex)

Initializes this struct with the specified values.

public FMOD_STUDIO_SOUND_INFO

Returns:

this struct
set
(FMOD_STUDIO_SOUND_INFO
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 int

Returns:

the value of the subsoundindex field.
subsoundindex
()

public FMOD_STUDIO_SOUND_INFO
subsoundindex(int value)

Sets the specified value to the subsoundindex 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.

EXINFOback to summary
public static final int EXINFO

The struct member offsets.

MODEback to summary
public static final int MODE

The struct member offsets.

NAME_OR_DATAback to summary
public static final int NAME_OR_DATA

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SUBSOUNDINDEXback to summary
public static final int SUBSOUNDINDEX

The struct member offsets.

Constructor Detail

FMOD_STUDIO_SOUND_INFOback to summary
protected FMOD_STUDIO_SOUND_INFO(long address, ByteBuffer container)
FMOD_STUDIO_SOUND_INFOback to summary
public FMOD_STUDIO_SOUND_INFO(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static FMOD_STUDIO_SOUND_INFO calloc(MemoryStack stack)

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

Returns a new FMOD_STUDIO_SOUND_INFO.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_STUDIO_SOUND_INFO 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_STUDIO_SOUND_INFO create()

Returns a new FMOD_STUDIO_SOUND_INFO instance allocated with BufferUtils.

createback to summary
public static FMOD_STUDIO_SOUND_INFO create(long address)

Returns a new FMOD_STUDIO_SOUND_INFO instance for the specified memory address.

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

Returns a new FMOD_STUDIO_SOUND_INFO.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a FMOD_STUDIO_SOUND_INFO.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static FMOD_STUDIO_SOUND_INFO createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
exinfoback to summary
public FMOD_CREATESOUNDEXINFO exinfo()
Returns:FMOD_CREATESOUNDEXINFO

a FMOD_CREATESOUNDEXINFO view of the exinfo field.

exinfoback to summary
public FMOD_STUDIO_SOUND_INFO exinfo(FMOD_CREATESOUNDEXINFO value)

Copies the specified FMOD_CREATESOUNDEXINFO to the exinfo field.

exinfoback to summary
public FMOD_STUDIO_SOUND_INFO exinfo(Consumer<FMOD_CREATESOUNDEXINFO> consumer)

Passes the exinfo field to the specified Consumer.

mallocback to summary
public static FMOD_STUDIO_SOUND_INFO malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static FMOD_STUDIO_SOUND_INFO malloc(MemoryStack stack)

Returns a new FMOD_STUDIO_SOUND_INFO instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

modeback to summary
public int mode()
Returns:int

the value of the mode field.

Annotations
@NativeType:FMOD_MODE
modeback to summary
public FMOD_STUDIO_SOUND_INFO mode(int value)

Sets the specified value to the mode field.

name_or_databack to summary
public ByteBuffer name_or_data(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 name_or_data field.

Annotations
@NativeType:char const *
name_or_databack to summary
public FMOD_STUDIO_SOUND_INFO name_or_data(ByteBuffer value)

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

nexinfoback to summary
public static FMOD_CREATESOUNDEXINFO nexinfo(long struct)

Unsafe version of exinfo.

nexinfoback to summary
public static void nexinfo(long struct, FMOD_CREATESOUNDEXINFO value)

Unsafe version of exinfo.

nmodeback to summary
public static int nmode(long struct)

Unsafe version of mode.

nmodeback to summary
public static void nmode(long struct, int value)

Unsafe version of mode.

nname_or_databack to summary
public static ByteBuffer nname_or_data(long struct, int capacity)

Unsafe version of name_or_data.

nname_or_databack to summary
public static void nname_or_data(long struct, ByteBuffer value)

Unsafe version of name_or_data.

nsubsoundindexback to summary
public static int nsubsoundindex(long struct)

Unsafe version of subsoundindex.

nsubsoundindexback to summary
public static void nsubsoundindex(long struct, int value)

Unsafe version of subsoundindex.

setback to summary
public FMOD_STUDIO_SOUND_INFO set(ByteBuffer name_or_data, int mode, FMOD_CREATESOUNDEXINFO exinfo, int subsoundindex)

Initializes this struct with the specified values.

setback to summary
public FMOD_STUDIO_SOUND_INFO set(FMOD_STUDIO_SOUND_INFO src)

Copies the specified struct data to this struct.

Parameters
src:FMOD_STUDIO_SOUND_INFO

the source struct

Returns:FMOD_STUDIO_SOUND_INFO

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
subsoundindexback to summary
public int subsoundindex()
Returns:int

the value of the subsoundindex field.

subsoundindexback to summary
public FMOD_STUDIO_SOUND_INFO subsoundindex(int value)

Sets the specified value to the subsoundindex 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.fmod back to summary

public Class FMOD_STUDIO_SOUND_INFO.Buffer

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

An array of FMOD_STUDIO_SOUND_INFO structs.

Field Summary

Modifier and TypeField and Description
private static final FMOD_STUDIO_SOUND_INFO

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new FMOD_STUDIO_SOUND_INFO.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_CREATESOUNDEXINFO

Returns:

a FMOD_CREATESOUNDEXINFO view of the exinfo field.
exinfo
()

public FMOD_STUDIO_SOUND_INFO.Buffer
exinfo(FMOD_CREATESOUNDEXINFO value)

Copies the specified FMOD_CREATESOUNDEXINFO to the exinfo field.

public FMOD_STUDIO_SOUND_INFO.Buffer
exinfo(Consumer<FMOD_CREATESOUNDEXINFO> consumer)

Passes the exinfo field to the specified Consumer.

protected FMOD_STUDIO_SOUND_INFO
public int

Returns:

the value of the mode field.
mode
()

public FMOD_STUDIO_SOUND_INFO.Buffer
mode(int value)

Sets the specified value to the mode field.

public ByteBuffer

Returns:

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

public FMOD_STUDIO_SOUND_INFO.Buffer
name_or_data(ByteBuffer value)

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

protected FMOD_STUDIO_SOUND_INFO.Buffer
public int

Returns:

the value of the subsoundindex field.
subsoundindex
()

public FMOD_STUDIO_SOUND_INFO.Buffer
subsoundindex(int value)

Sets the specified value to the subsoundindex field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final FMOD_STUDIO_SOUND_INFO ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

exinfoback to summary
public FMOD_CREATESOUNDEXINFO exinfo()
Returns:FMOD_CREATESOUNDEXINFO

a FMOD_CREATESOUNDEXINFO view of the exinfo field.

exinfoback to summary
public FMOD_STUDIO_SOUND_INFO.Buffer exinfo(FMOD_CREATESOUNDEXINFO value)

Copies the specified FMOD_CREATESOUNDEXINFO to the exinfo field.

exinfoback to summary
public FMOD_STUDIO_SOUND_INFO.Buffer exinfo(Consumer<FMOD_CREATESOUNDEXINFO> consumer)

Passes the exinfo field to the specified Consumer.

getElementFactoryback to summary
protected FMOD_STUDIO_SOUND_INFO getElementFactory()

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

Annotations
@Override
modeback to summary
public int mode()
Returns:int

the value of the mode field.

Annotations
@NativeType:FMOD_MODE
modeback to summary
public FMOD_STUDIO_SOUND_INFO.Buffer mode(int value)

Sets the specified value to the mode field.

name_or_databack to summary
public ByteBuffer name_or_data(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 name_or_data field.

Annotations
@NativeType:char const *
name_or_databack to summary
public FMOD_STUDIO_SOUND_INFO.Buffer name_or_data(ByteBuffer value)

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

selfback to summary
protected FMOD_STUDIO_SOUND_INFO.Buffer self()

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

Annotations
@Override
subsoundindexback to summary
public int subsoundindex()
Returns:int

the value of the subsoundindex field.

subsoundindexback to summary
public FMOD_STUDIO_SOUND_INFO.Buffer subsoundindex(int value)

Sets the specified value to the subsoundindex field.