Class FMOD_STUDIO_SOUND_INFO

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<FMOD_STUDIO_SOUND_INFO>

org.lwjgl.fmod.FMOD_STUDIO_SOUND_INFO

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class FMOD_STUDIO_SOUND_INFO
extends Struct<FMOD_STUDIO_SOUND_INFO>
implements NativeResource

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	EXINFO	The struct member offsets.
static final int	MODE	The struct member offsets.
static final int	NAME_OR_DATA	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SUBSOUNDINDEX	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
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 Type	Method	Description
static FMOD_STUDIO_SOUND_INFO	calloc()	Returns a new FMOD_STUDIO_SOUND_INFO instance allocated with memCalloc.
static FMOD_STUDIO_SOUND_INFO.Buffer	calloc(int capacity)	Returns a new FMOD_STUDIO_SOUND_INFO.Buffer instance allocated with memCalloc.
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.
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.
static FMOD_STUDIO_SOUND_INFO	create()	Returns a new FMOD_STUDIO_SOUND_INFO instance allocated with BufferUtils.
static FMOD_STUDIO_SOUND_INFO.Buffer	create(int capacity)	Returns a new FMOD_STUDIO_SOUND_INFO.Buffer instance allocated with BufferUtils.
static FMOD_STUDIO_SOUND_INFO	create(long address)	Returns a new FMOD_STUDIO_SOUND_INFO instance for the specified memory address.
static FMOD_STUDIO_SOUND_INFO.Buffer	create(long address, int capacity)	Create a FMOD_STUDIO_SOUND_INFO.Buffer instance at the specified memory.
static @Nullable FMOD_STUDIO_SOUND_INFO	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable FMOD_STUDIO_SOUND_INFO.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
FMOD_CREATESOUNDEXINFO	exinfo()
FMOD_STUDIO_SOUND_INFO	exinfo(Consumer<FMOD_CREATESOUNDEXINFO> consumer)	Passes the exinfo field to the specified Consumer.
FMOD_STUDIO_SOUND_INFO	exinfo(FMOD_CREATESOUNDEXINFO value)	Copies the specified FMOD_CREATESOUNDEXINFO to the exinfo field.
static FMOD_STUDIO_SOUND_INFO	malloc()	Returns a new FMOD_STUDIO_SOUND_INFO instance allocated with memAlloc.
static FMOD_STUDIO_SOUND_INFO.Buffer	malloc(int capacity)	Returns a new FMOD_STUDIO_SOUND_INFO.Buffer instance allocated with memAlloc.
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.
static FMOD_STUDIO_SOUND_INFO	malloc(MemoryStack stack)	Returns a new FMOD_STUDIO_SOUND_INFO instance allocated on the specified MemoryStack.
int	mode()
FMOD_STUDIO_SOUND_INFO	mode(int value)	Sets the specified value to the mode field.
ByteBuffer	name_or_data(int capacity)
FMOD_STUDIO_SOUND_INFO	name_or_data(ByteBuffer value)	Sets the address of the specified ByteBuffer to the name_or_data field.
static FMOD_CREATESOUNDEXINFO	nexinfo(long struct)	Unsafe version of exinfo().
static void	nexinfo(long struct, FMOD_CREATESOUNDEXINFO value)	Unsafe version of exinfo.
static int	nmode(long struct)	Unsafe version of mode().
static void	nmode(long struct, int value)	Unsafe version of mode.
static ByteBuffer	nname_or_data(long struct, int capacity)	Unsafe version of name_or_data.
static void	nname_or_data(long struct, ByteBuffer value)	Unsafe version of name_or_data.
static int	nsubsoundindex(long struct)	Unsafe version of subsoundindex().
static void	nsubsoundindex(long struct, int value)	Unsafe version of subsoundindex.
FMOD_STUDIO_SOUND_INFO	set(ByteBuffer name_or_data, int mode, FMOD_CREATESOUNDEXINFO exinfo, int subsoundindex)	Initializes this struct with the specified values.
FMOD_STUDIO_SOUND_INFO	set(FMOD_STUDIO_SOUND_INFO src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	subsoundindex()
FMOD_STUDIO_SOUND_INFO	subsoundindex(int value)	Sets the specified value to the subsoundindex field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

NAME_OR_DATA

public static final int NAME_OR_DATA

The struct member offsets.

MODE

public static final int MODE

The struct member offsets.

EXINFO

public static final int EXINFO

The struct member offsets.

SUBSOUNDINDEX

public static final int SUBSOUNDINDEX

The struct member offsets.

Constructor Details

FMOD_STUDIO_SOUND_INFO

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<FMOD_STUDIO_SOUND_INFO>

name_or_data

@NativeType("char const *")
public ByteBuffer name_or_data(int capacity)

Returns:

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

mode

@NativeType("FMOD_MODE")
public int mode()

Returns:

the value of the mode field.

exinfo

public FMOD_CREATESOUNDEXINFO exinfo()

Returns:

a FMOD_CREATESOUNDEXINFO view of the exinfo field.

subsoundindex

public int subsoundindex()

Returns:

the value of the subsoundindex field.

name_or_data

public FMOD_STUDIO_SOUND_INFO name_or_data(@NativeType("char const *")
 ByteBuffer value)

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

mode

public FMOD_STUDIO_SOUND_INFO mode(@NativeType("FMOD_MODE")
 int value)

Sets the specified value to the mode field.

exinfo

public FMOD_STUDIO_SOUND_INFO exinfo(FMOD_CREATESOUNDEXINFO value)

Copies the specified FMOD_CREATESOUNDEXINFO to the exinfo field.

exinfo

public FMOD_STUDIO_SOUND_INFO exinfo(Consumer<FMOD_CREATESOUNDEXINFO> consumer)

Passes the exinfo field to the specified Consumer.

subsoundindex

public FMOD_STUDIO_SOUND_INFO subsoundindex(int value)

Sets the specified value to the subsoundindex field.

set

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

Initializes this struct with the specified values.

set

public FMOD_STUDIO_SOUND_INFO set(FMOD_STUDIO_SOUND_INFO src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static FMOD_STUDIO_SOUND_INFO malloc()

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

calloc

public static FMOD_STUDIO_SOUND_INFO calloc()

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

create

public static FMOD_STUDIO_SOUND_INFO create()

Returns a new FMOD_STUDIO_SOUND_INFO instance allocated with BufferUtils.

create

public static FMOD_STUDIO_SOUND_INFO create(long address)

Returns a new FMOD_STUDIO_SOUND_INFO instance for the specified memory address.

createSafe

public static @Nullable FMOD_STUDIO_SOUND_INFO createSafe(long address)

Like create, but returns null if address is NULL.

malloc

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

calloc

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

create

public static FMOD_STUDIO_SOUND_INFO.Buffer create(int capacity)

Returns a new FMOD_STUDIO_SOUND_INFO.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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 - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static FMOD_STUDIO_SOUND_INFO malloc(MemoryStack stack)

Returns a new FMOD_STUDIO_SOUND_INFO instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

malloc

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

stack - the stack from which to allocate

calloc

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

stack - the stack from which to allocate

nname_or_data

public static ByteBuffer nname_or_data(long struct,
 int capacity)

Unsafe version of name_or_data.

nmode

public static int nmode(long struct)

Unsafe version of mode().

nexinfo

public static FMOD_CREATESOUNDEXINFO nexinfo(long struct)

Unsafe version of exinfo().

nsubsoundindex

public static int nsubsoundindex(long struct)

Unsafe version of subsoundindex().

nname_or_data

public static void nname_or_data(long struct,
 ByteBuffer value)

Unsafe version of name_or_data.

nmode

public static void nmode(long struct,
 int value)

Unsafe version of mode.

nexinfo

public static void nexinfo(long struct,
 FMOD_CREATESOUNDEXINFO value)

Unsafe version of exinfo.

nsubsoundindex

public static void nsubsoundindex(long struct,
 int value)

Unsafe version of subsoundindex.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate