Class FMOD_DSP_PARAMETER_DESC

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<FMOD_DSP_PARAMETER_DESC>

org.lwjgl.fmod.FMOD_DSP_PARAMETER_DESC

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class FMOD_DSP_PARAMETER_DESC
extends Struct<FMOD_DSP_PARAMETER_DESC>
implements NativeResource

struct FMOD_DSP_PARAMETER_DESC {
    FMOD_DSP_PARAMETER_TYPE type;
    char name[16];
    char label[16];
    char const * description;
    union {
        FMOD_DSP_PARAMETER_DESC_FLOAT floatdesc;
        FMOD_DSP_PARAMETER_DESC_INT intdesc;
        FMOD_DSP_PARAMETER_DESC_BOOL booldesc;
        FMOD_DSP_PARAMETER_DESC_DATA datadesc;
    };
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FMOD_DSP_PARAMETER_DESC.Buffer	An array of FMOD_DSP_PARAMETER_DESC 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	BOOLDESC	The struct member offsets.
static final int	DATADESC	The struct member offsets.
static final int	DESCRIPTION	The struct member offsets.
static final int	FLOATDESC	The struct member offsets.
static final int	INTDESC	The struct member offsets.
static final int	LABEL	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_DSP_PARAMETER_DESC(ByteBuffer container)	Creates a FMOD_DSP_PARAMETER_DESC instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
FMOD_DSP_PARAMETER_DESC_BOOL	booldesc()
FMOD_DSP_PARAMETER_DESC	booldesc(Consumer<FMOD_DSP_PARAMETER_DESC_BOOL> consumer)	Passes the booldesc field to the specified Consumer.
FMOD_DSP_PARAMETER_DESC	booldesc(FMOD_DSP_PARAMETER_DESC_BOOL value)	Copies the specified FMOD_DSP_PARAMETER_DESC_BOOL to the booldesc field.
static FMOD_DSP_PARAMETER_DESC	calloc()	Returns a new FMOD_DSP_PARAMETER_DESC instance allocated with memCalloc.
static FMOD_DSP_PARAMETER_DESC.Buffer	calloc(int capacity)	Returns a new FMOD_DSP_PARAMETER_DESC.Buffer instance allocated with memCalloc.
static FMOD_DSP_PARAMETER_DESC.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new FMOD_DSP_PARAMETER_DESC.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static FMOD_DSP_PARAMETER_DESC	calloc(MemoryStack stack)	Returns a new FMOD_DSP_PARAMETER_DESC instance allocated on the specified MemoryStack and initializes all its bits to zero.
static FMOD_DSP_PARAMETER_DESC	create()	Returns a new FMOD_DSP_PARAMETER_DESC instance allocated with BufferUtils.
static FMOD_DSP_PARAMETER_DESC.Buffer	create(int capacity)	Returns a new FMOD_DSP_PARAMETER_DESC.Buffer instance allocated with BufferUtils.
static FMOD_DSP_PARAMETER_DESC	create(long address)	Returns a new FMOD_DSP_PARAMETER_DESC instance for the specified memory address.
static FMOD_DSP_PARAMETER_DESC.Buffer	create(long address, int capacity)	Create a FMOD_DSP_PARAMETER_DESC.Buffer instance at the specified memory.
static @Nullable FMOD_DSP_PARAMETER_DESC	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable FMOD_DSP_PARAMETER_DESC.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
FMOD_DSP_PARAMETER_DESC_DATA	datadesc()
FMOD_DSP_PARAMETER_DESC	datadesc(Consumer<FMOD_DSP_PARAMETER_DESC_DATA> consumer)	Passes the datadesc field to the specified Consumer.
FMOD_DSP_PARAMETER_DESC	datadesc(FMOD_DSP_PARAMETER_DESC_DATA value)	Copies the specified FMOD_DSP_PARAMETER_DESC_DATA to the datadesc field.
ByteBuffer	description()
FMOD_DSP_PARAMETER_DESC	description(ByteBuffer value)	Sets the address of the specified encoded string to the description field.
String	descriptionString()
FMOD_DSP_PARAMETER_DESC_FLOAT	floatdesc()
FMOD_DSP_PARAMETER_DESC	floatdesc(Consumer<FMOD_DSP_PARAMETER_DESC_FLOAT> consumer)	Passes the floatdesc field to the specified Consumer.
FMOD_DSP_PARAMETER_DESC	floatdesc(FMOD_DSP_PARAMETER_DESC_FLOAT value)	Copies the specified FMOD_DSP_PARAMETER_DESC_FLOAT to the floatdesc field.
FMOD_DSP_PARAMETER_DESC_INT	intdesc()
FMOD_DSP_PARAMETER_DESC	intdesc(Consumer<FMOD_DSP_PARAMETER_DESC_INT> consumer)	Passes the intdesc field to the specified Consumer.
FMOD_DSP_PARAMETER_DESC	intdesc(FMOD_DSP_PARAMETER_DESC_INT value)	Copies the specified FMOD_DSP_PARAMETER_DESC_INT to the intdesc field.
ByteBuffer	label()
byte	label(int index)
FMOD_DSP_PARAMETER_DESC	label(int index, byte value)	Sets the specified value at the specified index of the label field.
FMOD_DSP_PARAMETER_DESC	label(ByteBuffer value)	Copies the specified ByteBuffer to the label field.
static FMOD_DSP_PARAMETER_DESC	malloc()	Returns a new FMOD_DSP_PARAMETER_DESC instance allocated with memAlloc.
static FMOD_DSP_PARAMETER_DESC.Buffer	malloc(int capacity)	Returns a new FMOD_DSP_PARAMETER_DESC.Buffer instance allocated with memAlloc.
static FMOD_DSP_PARAMETER_DESC.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new FMOD_DSP_PARAMETER_DESC.Buffer instance allocated on the specified MemoryStack.
static FMOD_DSP_PARAMETER_DESC	malloc(MemoryStack stack)	Returns a new FMOD_DSP_PARAMETER_DESC instance allocated on the specified MemoryStack.
ByteBuffer	name()
byte	name(int index)
FMOD_DSP_PARAMETER_DESC	name(int index, byte value)	Sets the specified value at the specified index of the name field.
FMOD_DSP_PARAMETER_DESC	name(ByteBuffer value)	Copies the specified ByteBuffer to the name field.
static FMOD_DSP_PARAMETER_DESC_BOOL	nbooldesc(long struct)	Unsafe version of booldesc().
static void	nbooldesc(long struct, FMOD_DSP_PARAMETER_DESC_BOOL value)	Unsafe version of booldesc.
static FMOD_DSP_PARAMETER_DESC_DATA	ndatadesc(long struct)	Unsafe version of datadesc().
static void	ndatadesc(long struct, FMOD_DSP_PARAMETER_DESC_DATA value)	Unsafe version of datadesc.
static ByteBuffer	ndescription(long struct)	Unsafe version of description().
static void	ndescription(long struct, ByteBuffer value)	Unsafe version of description.
static String	ndescriptionString(long struct)	Unsafe version of descriptionString().
static FMOD_DSP_PARAMETER_DESC_FLOAT	nfloatdesc(long struct)	Unsafe version of floatdesc().
static void	nfloatdesc(long struct, FMOD_DSP_PARAMETER_DESC_FLOAT value)	Unsafe version of floatdesc.
static FMOD_DSP_PARAMETER_DESC_INT	nintdesc(long struct)	Unsafe version of intdesc().
static void	nintdesc(long struct, FMOD_DSP_PARAMETER_DESC_INT value)	Unsafe version of intdesc.
static ByteBuffer	nlabel(long struct)	Unsafe version of label().
static byte	nlabel(long struct, int index)	Unsafe version of label.
static void	nlabel(long struct, int index, byte value)	Unsafe version of label.
static void	nlabel(long struct, ByteBuffer value)	Unsafe version of label.
static ByteBuffer	nname(long struct)	Unsafe version of name().
static byte	nname(long struct, int index)	Unsafe version of name.
static void	nname(long struct, int index, byte value)	Unsafe version of name.
static void	nname(long struct, ByteBuffer value)	Unsafe version of name.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
FMOD_DSP_PARAMETER_DESC	set(FMOD_DSP_PARAMETER_DESC src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	type()
FMOD_DSP_PARAMETER_DESC	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.

TYPE

public static final int TYPE

The struct member offsets.

NAME

public static final int NAME

The struct member offsets.

LABEL

public static final int LABEL

The struct member offsets.

DESCRIPTION

public static final int DESCRIPTION

The struct member offsets.

FLOATDESC

public static final int FLOATDESC

The struct member offsets.

INTDESC

public static final int INTDESC

The struct member offsets.

BOOLDESC

public static final int BOOLDESC

The struct member offsets.

DATADESC

public static final int DATADESC

The struct member offsets.

Constructor Details

FMOD_DSP_PARAMETER_DESC

public FMOD_DSP_PARAMETER_DESC(ByteBuffer container)

Creates a FMOD_DSP_PARAMETER_DESC 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_DSP_PARAMETER_DESC>

type

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

Returns:

the value of the type field.

name

@NativeType("char[16]")
public ByteBuffer name()

Returns:

a ByteBuffer view of the name field.

name

@NativeType("char")
public byte name(int index)

Returns:

the value at the specified index of the name field.

label

@NativeType("char[16]")
public ByteBuffer label()

Returns:

a ByteBuffer view of the label field.

label

@NativeType("char")
public byte label(int index)

Returns:

the value at the specified index of the label field.

description

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

Returns:

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

descriptionString

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

Returns:

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

floatdesc

public FMOD_DSP_PARAMETER_DESC_FLOAT floatdesc()

Returns:

a FMOD_DSP_PARAMETER_DESC_FLOAT view of the floatdesc field.

intdesc

public FMOD_DSP_PARAMETER_DESC_INT intdesc()

Returns:

a FMOD_DSP_PARAMETER_DESC_INT view of the intdesc field.

booldesc

public FMOD_DSP_PARAMETER_DESC_BOOL booldesc()

Returns:

a FMOD_DSP_PARAMETER_DESC_BOOL view of the booldesc field.

datadesc

public FMOD_DSP_PARAMETER_DESC_DATA datadesc()

Returns:

a FMOD_DSP_PARAMETER_DESC_DATA view of the datadesc field.

type

public FMOD_DSP_PARAMETER_DESC type(@NativeType("FMOD_DSP_PARAMETER_TYPE")
 int value)

Sets the specified value to the type field.

name

public FMOD_DSP_PARAMETER_DESC name(@NativeType("char[16]")
 ByteBuffer value)

Copies the specified ByteBuffer to the name field.

name

public FMOD_DSP_PARAMETER_DESC name(int index,
 @NativeType("char")
 byte value)

Sets the specified value at the specified index of the name field.

label

public FMOD_DSP_PARAMETER_DESC label(@NativeType("char[16]")
 ByteBuffer value)

Copies the specified ByteBuffer to the label field.

label

public FMOD_DSP_PARAMETER_DESC label(int index,
 @NativeType("char")
 byte value)

Sets the specified value at the specified index of the label field.

description

public FMOD_DSP_PARAMETER_DESC description(@NativeType("char const *")
 ByteBuffer value)

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

floatdesc

public FMOD_DSP_PARAMETER_DESC floatdesc(FMOD_DSP_PARAMETER_DESC_FLOAT value)

Copies the specified FMOD_DSP_PARAMETER_DESC_FLOAT to the floatdesc field.

floatdesc

public FMOD_DSP_PARAMETER_DESC floatdesc(Consumer<FMOD_DSP_PARAMETER_DESC_FLOAT> consumer)

Passes the floatdesc field to the specified Consumer.

intdesc

public FMOD_DSP_PARAMETER_DESC intdesc(FMOD_DSP_PARAMETER_DESC_INT value)

Copies the specified FMOD_DSP_PARAMETER_DESC_INT to the intdesc field.

intdesc

public FMOD_DSP_PARAMETER_DESC intdesc(Consumer<FMOD_DSP_PARAMETER_DESC_INT> consumer)

Passes the intdesc field to the specified Consumer.

booldesc

public FMOD_DSP_PARAMETER_DESC booldesc(FMOD_DSP_PARAMETER_DESC_BOOL value)

Copies the specified FMOD_DSP_PARAMETER_DESC_BOOL to the booldesc field.

booldesc

public FMOD_DSP_PARAMETER_DESC booldesc(Consumer<FMOD_DSP_PARAMETER_DESC_BOOL> consumer)

Passes the booldesc field to the specified Consumer.

datadesc

public FMOD_DSP_PARAMETER_DESC datadesc(FMOD_DSP_PARAMETER_DESC_DATA value)

Copies the specified FMOD_DSP_PARAMETER_DESC_DATA to the datadesc field.

datadesc

public FMOD_DSP_PARAMETER_DESC datadesc(Consumer<FMOD_DSP_PARAMETER_DESC_DATA> consumer)

Passes the datadesc field to the specified Consumer.

set

public FMOD_DSP_PARAMETER_DESC set(FMOD_DSP_PARAMETER_DESC src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static FMOD_DSP_PARAMETER_DESC malloc()

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

calloc

public static FMOD_DSP_PARAMETER_DESC calloc()

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

create

public static FMOD_DSP_PARAMETER_DESC create()

Returns a new FMOD_DSP_PARAMETER_DESC instance allocated with BufferUtils.

create

public static FMOD_DSP_PARAMETER_DESC create(long address)

Returns a new FMOD_DSP_PARAMETER_DESC instance for the specified memory address.

createSafe

public static @Nullable FMOD_DSP_PARAMETER_DESC createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static FMOD_DSP_PARAMETER_DESC.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static FMOD_DSP_PARAMETER_DESC.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static FMOD_DSP_PARAMETER_DESC.Buffer create(int capacity)

Returns a new FMOD_DSP_PARAMETER_DESC.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a FMOD_DSP_PARAMETER_DESC.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static FMOD_DSP_PARAMETER_DESC malloc(MemoryStack stack)

Returns a new FMOD_DSP_PARAMETER_DESC instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static FMOD_DSP_PARAMETER_DESC calloc(MemoryStack stack)

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ntype

public static int ntype(long struct)

Unsafe version of type().

nname

public static ByteBuffer nname(long struct)

Unsafe version of name().

nname

public static byte nname(long struct,
 int index)

Unsafe version of name.

nlabel

public static ByteBuffer nlabel(long struct)

Unsafe version of label().

nlabel

public static byte nlabel(long struct,
 int index)

Unsafe version of label.

ndescription

public static ByteBuffer ndescription(long struct)

Unsafe version of description().

ndescriptionString

public static String ndescriptionString(long struct)

Unsafe version of descriptionString().

nfloatdesc

public static FMOD_DSP_PARAMETER_DESC_FLOAT nfloatdesc(long struct)

Unsafe version of floatdesc().

nintdesc

public static FMOD_DSP_PARAMETER_DESC_INT nintdesc(long struct)

Unsafe version of intdesc().

nbooldesc

public static FMOD_DSP_PARAMETER_DESC_BOOL nbooldesc(long struct)

Unsafe version of booldesc().

ndatadesc

public static FMOD_DSP_PARAMETER_DESC_DATA ndatadesc(long struct)

Unsafe version of datadesc().

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nname

public static void nname(long struct,
 ByteBuffer value)

Unsafe version of name.

nname

public static void nname(long struct,
 int index,
 byte value)

Unsafe version of name.

nlabel

public static void nlabel(long struct,
 ByteBuffer value)

Unsafe version of label.

nlabel

public static void nlabel(long struct,
 int index,
 byte value)

Unsafe version of label.

ndescription

public static void ndescription(long struct,
 ByteBuffer value)

Unsafe version of description.

nfloatdesc

public static void nfloatdesc(long struct,
 FMOD_DSP_PARAMETER_DESC_FLOAT value)

Unsafe version of floatdesc.

nintdesc

public static void nintdesc(long struct,
 FMOD_DSP_PARAMETER_DESC_INT value)

Unsafe version of intdesc.

nbooldesc

public static void nbooldesc(long struct,
 FMOD_DSP_PARAMETER_DESC_BOOL value)

Unsafe version of booldesc.

ndatadesc

public static void ndatadesc(long struct,
 FMOD_DSP_PARAMETER_DESC_DATA value)

Unsafe version of datadesc.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate