Package org.lwjgl.fmod

Class FMOD_DSP_PARAMETER_DESC_FLOAT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<FMOD_DSP_PARAMETER_DESC_FLOAT>

org.lwjgl.fmod.FMOD_DSP_PARAMETER_DESC_FLOAT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class FMOD_DSP_PARAMETER_DESC_FLOAT
extends Struct<FMOD_DSP_PARAMETER_DESC_FLOAT>
implements NativeResource

 struct FMOD_DSP_PARAMETER_DESC_FLOAT {
     float min;
     float max;
     float defaultval;
     {@link FMOD_DSP_PARAMETER_FLOAT_MAPPING FMOD_DSP_PARAMETER_FLOAT_MAPPING} mapping;
 }

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DEFAULTVAL	The struct member offsets.
static final int	MAPPING	The struct member offsets.
static final int	MAX	The struct member offsets.
static final int	MIN	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
FMOD_DSP_PARAMETER_DESC_FLOAT(ByteBuffer container)	Creates a FMOD_DSP_PARAMETER_DESC_FLOAT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static FMOD_DSP_PARAMETER_DESC_FLOAT	calloc()	Returns a new FMOD_DSP_PARAMETER_DESC_FLOAT instance allocated with memCalloc.
static FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer	calloc(int capacity)	Returns a new FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer instance allocated with memCalloc.
static FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static FMOD_DSP_PARAMETER_DESC_FLOAT	calloc(MemoryStack stack)	Returns a new FMOD_DSP_PARAMETER_DESC_FLOAT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static FMOD_DSP_PARAMETER_DESC_FLOAT	create()	Returns a new FMOD_DSP_PARAMETER_DESC_FLOAT instance allocated with BufferUtils.
static FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer	create(int capacity)	Returns a new FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer instance allocated with BufferUtils.
static FMOD_DSP_PARAMETER_DESC_FLOAT	create(long address)	Returns a new FMOD_DSP_PARAMETER_DESC_FLOAT instance for the specified memory address.
static FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer	create(long address, int capacity)	Create a FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer instance at the specified memory.
static @Nullable FMOD_DSP_PARAMETER_DESC_FLOAT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
float	defaultval()
FMOD_DSP_PARAMETER_DESC_FLOAT	defaultval(float value)	Sets the specified value to the defaultval field.
static FMOD_DSP_PARAMETER_DESC_FLOAT	malloc()	Returns a new FMOD_DSP_PARAMETER_DESC_FLOAT instance allocated with memAlloc.
static FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer	malloc(int capacity)	Returns a new FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer instance allocated with memAlloc.
static FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer instance allocated on the specified MemoryStack.
static FMOD_DSP_PARAMETER_DESC_FLOAT	malloc(MemoryStack stack)	Returns a new FMOD_DSP_PARAMETER_DESC_FLOAT instance allocated on the specified MemoryStack.
FMOD_DSP_PARAMETER_FLOAT_MAPPING	mapping()
FMOD_DSP_PARAMETER_DESC_FLOAT	mapping(Consumer<FMOD_DSP_PARAMETER_FLOAT_MAPPING> consumer)	Passes the mapping field to the specified Consumer.
FMOD_DSP_PARAMETER_DESC_FLOAT	mapping(FMOD_DSP_PARAMETER_FLOAT_MAPPING value)	Copies the specified FMOD_DSP_PARAMETER_FLOAT_MAPPING to the mapping field.
float	max()
FMOD_DSP_PARAMETER_DESC_FLOAT	max(float value)	Sets the specified value to the max field.
float	min()
FMOD_DSP_PARAMETER_DESC_FLOAT	min(float value)	Sets the specified value to the min field.
static float	ndefaultval(long struct)	Unsafe version of defaultval().
static void	ndefaultval(long struct, float value)	Unsafe version of defaultval.
static FMOD_DSP_PARAMETER_FLOAT_MAPPING	nmapping(long struct)	Unsafe version of mapping().
static void	nmapping(long struct, FMOD_DSP_PARAMETER_FLOAT_MAPPING value)	Unsafe version of mapping.
static float	nmax(long struct)	Unsafe version of max().
static void	nmax(long struct, float value)	Unsafe version of max.
static float	nmin(long struct)	Unsafe version of min().
static void	nmin(long struct, float value)	Unsafe version of min.
FMOD_DSP_PARAMETER_DESC_FLOAT	set(float min, float max, float defaultval, FMOD_DSP_PARAMETER_FLOAT_MAPPING mapping)	Initializes this struct with the specified values.
FMOD_DSP_PARAMETER_DESC_FLOAT	set(FMOD_DSP_PARAMETER_DESC_FLOAT src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

MIN

public static final int MIN

The struct member offsets.

MAX

public static final int MAX

The struct member offsets.

DEFAULTVAL

public static final int DEFAULTVAL

The struct member offsets.

MAPPING

public static final int MAPPING

The struct member offsets.

Constructor Details

FMOD_DSP_PARAMETER_DESC_FLOAT

public FMOD_DSP_PARAMETER_DESC_FLOAT(ByteBuffer container)

Creates a FMOD_DSP_PARAMETER_DESC_FLOAT 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_FLOAT>

min

public float min()

Returns:

the value of the min field.

max

public float max()

Returns:

the value of the max field.

defaultval

public float defaultval()

Returns:

the value of the defaultval field.

mapping

public FMOD_DSP_PARAMETER_FLOAT_MAPPING mapping()

Returns:

a FMOD_DSP_PARAMETER_FLOAT_MAPPING view of the mapping field.

min

public FMOD_DSP_PARAMETER_DESC_FLOAT min(float value)

Sets the specified value to the min field.

max

public FMOD_DSP_PARAMETER_DESC_FLOAT max(float value)

Sets the specified value to the max field.

defaultval

public FMOD_DSP_PARAMETER_DESC_FLOAT defaultval(float value)

Sets the specified value to the defaultval field.

mapping

public FMOD_DSP_PARAMETER_DESC_FLOAT mapping(FMOD_DSP_PARAMETER_FLOAT_MAPPING value)

Copies the specified FMOD_DSP_PARAMETER_FLOAT_MAPPING to the mapping field.

mapping

public FMOD_DSP_PARAMETER_DESC_FLOAT mapping(Consumer<FMOD_DSP_PARAMETER_FLOAT_MAPPING> consumer)

Passes the mapping field to the specified Consumer.

set

public FMOD_DSP_PARAMETER_DESC_FLOAT set(float min,
 float max,
 float defaultval,
 FMOD_DSP_PARAMETER_FLOAT_MAPPING mapping)

Initializes this struct with the specified values.

set

public FMOD_DSP_PARAMETER_DESC_FLOAT set(FMOD_DSP_PARAMETER_DESC_FLOAT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static FMOD_DSP_PARAMETER_DESC_FLOAT malloc()

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

calloc

public static FMOD_DSP_PARAMETER_DESC_FLOAT calloc()

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

create

public static FMOD_DSP_PARAMETER_DESC_FLOAT create()

Returns a new FMOD_DSP_PARAMETER_DESC_FLOAT instance allocated with BufferUtils.

create

public static FMOD_DSP_PARAMETER_DESC_FLOAT create(long address)

Returns a new FMOD_DSP_PARAMETER_DESC_FLOAT instance for the specified memory address.

createSafe

public static @Nullable FMOD_DSP_PARAMETER_DESC_FLOAT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer create(int capacity)

Returns a new FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a FMOD_DSP_PARAMETER_DESC_FLOAT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static FMOD_DSP_PARAMETER_DESC_FLOAT malloc(MemoryStack stack)

Returns a new FMOD_DSP_PARAMETER_DESC_FLOAT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static FMOD_DSP_PARAMETER_DESC_FLOAT calloc(MemoryStack stack)

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

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

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

nmin

public static float nmin(long struct)

Unsafe version of min().

nmax

public static float nmax(long struct)

Unsafe version of max().

ndefaultval

public static float ndefaultval(long struct)

Unsafe version of defaultval().

nmapping

public static FMOD_DSP_PARAMETER_FLOAT_MAPPING nmapping(long struct)

Unsafe version of mapping().

nmin

public static void nmin(long struct,
 float value)

Unsafe version of min.

nmax

public static void nmax(long struct,
 float value)

Unsafe version of max.

ndefaultval

public static void ndefaultval(long struct,
 float value)

Unsafe version of defaultval.

nmapping

public static void nmapping(long struct,
 FMOD_DSP_PARAMETER_FLOAT_MAPPING value)

Unsafe version of mapping.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate