Class FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES>

org.lwjgl.fmod.FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES
extends Struct<FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES>
implements NativeResource

struct FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES {
    char const * name;
    FMOD_SOUND * sound;
    int subsoundIndex;
}

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES	calloc()	Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance allocated with memCalloc.
static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer	calloc(int capacity)	Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer instance allocated with memCalloc.
static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES	calloc(MemoryStack stack)	Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance allocated on the specified MemoryStack and initializes all its bits to zero.
static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES	create()	Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance allocated with BufferUtils.
static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer	create(int capacity)	Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer instance allocated with BufferUtils.
static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES	create(long address)	Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance for the specified memory address.
static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer	create(long address, int capacity)	Create a FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer instance at the specified memory.
static @Nullable FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES	malloc()	Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance allocated with memAlloc.
static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer	malloc(int capacity)	Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer instance allocated with memAlloc.
static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer instance allocated on the specified MemoryStack.
static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES	malloc(MemoryStack stack)	Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance allocated on the specified MemoryStack.
ByteBuffer	name()
FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES	name(ByteBuffer value)	Sets the address of the specified encoded string to the name field.
String	nameString()
static ByteBuffer	nname(long struct)	Unsafe version of name().
static void	nname(long struct, ByteBuffer value)	Unsafe version of name.
static String	nnameString(long struct)	Unsafe version of nameString().
static long	nsound(long struct)	Unsafe version of sound().
static void	nsound(long struct, long value)	Unsafe version of sound.
static int	nsubsoundIndex(long struct)	Unsafe version of subsoundIndex().
static void	nsubsoundIndex(long struct, int value)	Unsafe version of subsoundIndex.
FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES	set(ByteBuffer name, long sound, int subsoundIndex)	Initializes this struct with the specified values.
FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES	set(FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
long	sound()
FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES	sound(long value)	Sets the specified value to the sound field.
int	subsoundIndex()
FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES	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

public static final int NAME

The struct member offsets.

SOUND

public static final int SOUND

The struct member offsets.

SUBSOUNDINDEX

public static final int SUBSOUNDINDEX

The struct member offsets.

Constructor Details

FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES

public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES(ByteBuffer container)

Creates a FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES 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_PROGRAMMER_SOUND_PROPERTIES>

name

@NativeType("char const *")
public ByteBuffer name()

Returns:

a ByteBuffer view of the null-terminated string pointed to by the name field.

nameString

@NativeType("char const *")
public String nameString()

Returns:

the null-terminated string pointed to by the name field.

sound

@NativeType("FMOD_SOUND *")
public long sound()

Returns:

the value of the sound field.

subsoundIndex

public int subsoundIndex()

Returns:

the value of the subsoundIndex field.

name

public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES name(@NativeType("char const *")
 ByteBuffer value)

Sets the address of the specified encoded string to the name field.

sound

public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES sound(@NativeType("FMOD_SOUND *")
 long value)

Sets the specified value to the sound field.

subsoundIndex

public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES subsoundIndex(int value)

Sets the specified value to the subsoundIndex field.

set

public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES set(ByteBuffer name,
 long sound,
 int subsoundIndex)

Initializes this struct with the specified values.

set

public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES set(FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES malloc()

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

calloc

public static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES calloc()

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

create

public static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES create()

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance allocated with BufferUtils.

create

public static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES create(long address)

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance for the specified memory address.

createSafe

public static @Nullable FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer create(int capacity)

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES malloc(MemoryStack stack)

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES calloc(MemoryStack stack)

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES 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_PROGRAMMER_SOUND_PROPERTIES.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

public static ByteBuffer nname(long struct)

Unsafe version of name().

nnameString

public static String nnameString(long struct)

Unsafe version of nameString().

nsound

public static long nsound(long struct)

Unsafe version of sound().

nsubsoundIndex

public static int nsubsoundIndex(long struct)

Unsafe version of subsoundIndex().

nname

public static void nname(long struct,
 ByteBuffer value)

Unsafe version of name.

nsound

public static void nsound(long struct,
 long value)

Unsafe version of sound.

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