Class FMOD_STUDIO_PARAMETER_DESCRIPTION

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<FMOD_STUDIO_PARAMETER_DESCRIPTION>

org.lwjgl.fmod.FMOD_STUDIO_PARAMETER_DESCRIPTION

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class FMOD_STUDIO_PARAMETER_DESCRIPTION
extends Struct<FMOD_STUDIO_PARAMETER_DESCRIPTION>
implements NativeResource

struct FMOD_STUDIO_PARAMETER_DESCRIPTION {
    char const * name;
    FMOD_STUDIO_PARAMETER_ID id;
    float minimum;
    float maximum;
    float defaultvalue;
    FMOD_STUDIO_PARAMETER_TYPE type;
    FMOD_STUDIO_PARAMETER_FLAGS flags;
    FMOD_GUID guid;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer	An array of FMOD_STUDIO_PARAMETER_DESCRIPTION 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	DEFAULTVALUE	The struct member offsets.
static final int	FLAGS	The struct member offsets.
static final int	GUID	The struct member offsets.
static final int	ID	The struct member offsets.
static final int	MAXIMUM	The struct member offsets.
static final int	MINIMUM	The struct member offsets.
static final int	NAME	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	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_PARAMETER_DESCRIPTION(ByteBuffer container)	Creates a FMOD_STUDIO_PARAMETER_DESCRIPTION instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static FMOD_STUDIO_PARAMETER_DESCRIPTION	calloc()	Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION instance allocated with memCalloc.
static FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer	calloc(int capacity)	Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer instance allocated with memCalloc.
static FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static FMOD_STUDIO_PARAMETER_DESCRIPTION	calloc(MemoryStack stack)	Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION instance allocated on the specified MemoryStack and initializes all its bits to zero.
static FMOD_STUDIO_PARAMETER_DESCRIPTION	create()	Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION instance allocated with BufferUtils.
static FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer	create(int capacity)	Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer instance allocated with BufferUtils.
static FMOD_STUDIO_PARAMETER_DESCRIPTION	create(long address)	Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION instance for the specified memory address.
static FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer	create(long address, int capacity)	Create a FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer instance at the specified memory.
static @Nullable FMOD_STUDIO_PARAMETER_DESCRIPTION	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
float	defaultvalue()
FMOD_STUDIO_PARAMETER_DESCRIPTION	defaultvalue(float value)	Sets the specified value to the defaultvalue field.
int	flags()
FMOD_STUDIO_PARAMETER_DESCRIPTION	flags(int value)	Sets the specified value to the flags field.
FMOD_GUID	guid()
FMOD_STUDIO_PARAMETER_DESCRIPTION	guid(Consumer<FMOD_GUID> consumer)	Passes the guid field to the specified Consumer.
FMOD_STUDIO_PARAMETER_DESCRIPTION	guid(FMOD_GUID value)	Copies the specified FMOD_GUID to the guid field.
FMOD_STUDIO_PARAMETER_ID	id()
FMOD_STUDIO_PARAMETER_DESCRIPTION	id(Consumer<FMOD_STUDIO_PARAMETER_ID> consumer)	Passes the id field to the specified Consumer.
FMOD_STUDIO_PARAMETER_DESCRIPTION	id(FMOD_STUDIO_PARAMETER_ID value)	Copies the specified FMOD_STUDIO_PARAMETER_ID to the id field.
static FMOD_STUDIO_PARAMETER_DESCRIPTION	malloc()	Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION instance allocated with memAlloc.
static FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer	malloc(int capacity)	Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer instance allocated with memAlloc.
static FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer instance allocated on the specified MemoryStack.
static FMOD_STUDIO_PARAMETER_DESCRIPTION	malloc(MemoryStack stack)	Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION instance allocated on the specified MemoryStack.
float	maximum()
FMOD_STUDIO_PARAMETER_DESCRIPTION	maximum(float value)	Sets the specified value to the maximum field.
float	minimum()
FMOD_STUDIO_PARAMETER_DESCRIPTION	minimum(float value)	Sets the specified value to the minimum field.
ByteBuffer	name()
FMOD_STUDIO_PARAMETER_DESCRIPTION	name(ByteBuffer value)	Sets the address of the specified encoded string to the name field.
String	nameString()
static float	ndefaultvalue(long struct)	Unsafe version of defaultvalue().
static void	ndefaultvalue(long struct, float value)	Unsafe version of defaultvalue.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static FMOD_GUID	nguid(long struct)	Unsafe version of guid().
static void	nguid(long struct, FMOD_GUID value)	Unsafe version of guid.
static FMOD_STUDIO_PARAMETER_ID	nid(long struct)	Unsafe version of id().
static void	nid(long struct, FMOD_STUDIO_PARAMETER_ID value)	Unsafe version of id.
static float	nmaximum(long struct)	Unsafe version of maximum().
static void	nmaximum(long struct, float value)	Unsafe version of maximum.
static float	nminimum(long struct)	Unsafe version of minimum().
static void	nminimum(long struct, float value)	Unsafe version of minimum.
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 int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
FMOD_STUDIO_PARAMETER_DESCRIPTION	set(ByteBuffer name, FMOD_STUDIO_PARAMETER_ID id, float minimum, float maximum, float defaultvalue, int type, int flags, FMOD_GUID guid)	Initializes this struct with the specified values.
FMOD_STUDIO_PARAMETER_DESCRIPTION	set(FMOD_STUDIO_PARAMETER_DESCRIPTION src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	type()
FMOD_STUDIO_PARAMETER_DESCRIPTION	type(int value)	Sets the specified value to the type 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.

ID

public static final int ID

The struct member offsets.

MINIMUM

public static final int MINIMUM

The struct member offsets.

MAXIMUM

public static final int MAXIMUM

The struct member offsets.

DEFAULTVALUE

public static final int DEFAULTVALUE

The struct member offsets.

TYPE

public static final int TYPE

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

GUID

public static final int GUID

The struct member offsets.

Constructor Details

FMOD_STUDIO_PARAMETER_DESCRIPTION

public FMOD_STUDIO_PARAMETER_DESCRIPTION(ByteBuffer container)

Creates a FMOD_STUDIO_PARAMETER_DESCRIPTION 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_PARAMETER_DESCRIPTION>

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.

id

public FMOD_STUDIO_PARAMETER_ID id()

Returns:

a FMOD_STUDIO_PARAMETER_ID view of the id field.

minimum

public float minimum()

Returns:

the value of the minimum field.

maximum

public float maximum()

Returns:

the value of the maximum field.

defaultvalue

public float defaultvalue()

Returns:

the value of the defaultvalue field.

type

@NativeType("FMOD_STUDIO_PARAMETER_TYPE")
public int type()

Returns:

the value of the type field.

flags

@NativeType("FMOD_STUDIO_PARAMETER_FLAGS")
public int flags()

Returns:

the value of the flags field.

guid

public FMOD_GUID guid()

Returns:

a FMOD_GUID view of the guid field.

name

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

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

id

public FMOD_STUDIO_PARAMETER_DESCRIPTION id(FMOD_STUDIO_PARAMETER_ID value)

Copies the specified FMOD_STUDIO_PARAMETER_ID to the id field.

id

public FMOD_STUDIO_PARAMETER_DESCRIPTION id(Consumer<FMOD_STUDIO_PARAMETER_ID> consumer)

Passes the id field to the specified Consumer.

minimum

public FMOD_STUDIO_PARAMETER_DESCRIPTION minimum(float value)

Sets the specified value to the minimum field.

maximum

public FMOD_STUDIO_PARAMETER_DESCRIPTION maximum(float value)

Sets the specified value to the maximum field.

defaultvalue

public FMOD_STUDIO_PARAMETER_DESCRIPTION defaultvalue(float value)

Sets the specified value to the defaultvalue field.

type

public FMOD_STUDIO_PARAMETER_DESCRIPTION type(@NativeType("FMOD_STUDIO_PARAMETER_TYPE")
 int value)

Sets the specified value to the type field.

flags

public FMOD_STUDIO_PARAMETER_DESCRIPTION flags(@NativeType("FMOD_STUDIO_PARAMETER_FLAGS")
 int value)

Sets the specified value to the flags field.

guid

public FMOD_STUDIO_PARAMETER_DESCRIPTION guid(FMOD_GUID value)

Copies the specified FMOD_GUID to the guid field.

guid

public FMOD_STUDIO_PARAMETER_DESCRIPTION guid(Consumer<FMOD_GUID> consumer)

Passes the guid field to the specified Consumer.

set

public FMOD_STUDIO_PARAMETER_DESCRIPTION set(ByteBuffer name,
 FMOD_STUDIO_PARAMETER_ID id,
 float minimum,
 float maximum,
 float defaultvalue,
 int type,
 int flags,
 FMOD_GUID guid)

Initializes this struct with the specified values.

set

public FMOD_STUDIO_PARAMETER_DESCRIPTION set(FMOD_STUDIO_PARAMETER_DESCRIPTION src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static FMOD_STUDIO_PARAMETER_DESCRIPTION malloc()

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

calloc

public static FMOD_STUDIO_PARAMETER_DESCRIPTION calloc()

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

create

public static FMOD_STUDIO_PARAMETER_DESCRIPTION create()

Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION instance allocated with BufferUtils.

create

public static FMOD_STUDIO_PARAMETER_DESCRIPTION create(long address)

Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION instance for the specified memory address.

createSafe

public static @Nullable FMOD_STUDIO_PARAMETER_DESCRIPTION createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer create(int capacity)

Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a FMOD_STUDIO_PARAMETER_DESCRIPTION.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static FMOD_STUDIO_PARAMETER_DESCRIPTION malloc(MemoryStack stack)

Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static FMOD_STUDIO_PARAMETER_DESCRIPTION calloc(MemoryStack stack)

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new FMOD_STUDIO_PARAMETER_DESCRIPTION.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().

nid

public static FMOD_STUDIO_PARAMETER_ID nid(long struct)

Unsafe version of id().

nminimum

public static float nminimum(long struct)

Unsafe version of minimum().

nmaximum

public static float nmaximum(long struct)

Unsafe version of maximum().

ndefaultvalue

public static float ndefaultvalue(long struct)

Unsafe version of defaultvalue().

ntype

public static int ntype(long struct)

Unsafe version of type().

nflags

public static int nflags(long struct)

Unsafe version of flags().

nguid

public static FMOD_GUID nguid(long struct)

Unsafe version of guid().

nname

public static void nname(long struct,
 ByteBuffer value)

Unsafe version of name.

nid

public static void nid(long struct,
 FMOD_STUDIO_PARAMETER_ID value)

Unsafe version of id.

nminimum

public static void nminimum(long struct,
 float value)

Unsafe version of minimum.

nmaximum

public static void nmaximum(long struct,
 float value)

Unsafe version of maximum.

ndefaultvalue

public static void ndefaultvalue(long struct,
 float value)

Unsafe version of defaultvalue.

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

nguid

public static void nguid(long struct,
 FMOD_GUID value)

Unsafe version of guid.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate