Top Description Inners Fields Constructors Methods
org.lwjgl.fmod

public Class FMOD_STUDIO_USER_PROPERTY

extends Struct<FMOD_STUDIO_USER_PROPERTY>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


struct FMOD_STUDIO_USER_PROPERTY {
    char const * name;
    FMOD_STUDIO_USER_PROPERTY_TYPE type;
    union {
        int intvalue;
        FMOD_BOOL boolvalue;
        float floatvalue;
        char const * stringvalue;
    };
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BOOLVALUE

The struct member offsets.

public static final int
FLOATVALUE

The struct member offsets.

public static final int
INTVALUE

The struct member offsets.

public static final int
NAME

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STRINGVALUE

The struct member offsets.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
FMOD_STUDIO_USER_PROPERTY(long address, ByteBuffer container)

public
FMOD_STUDIO_USER_PROPERTY(ByteBuffer container)

Creates a FMOD_STUDIO_USER_PROPERTY instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the boolvalue field.
boolvalue
()

public FMOD_STUDIO_USER_PROPERTY
boolvalue(int value)

Sets the specified value to the boolvalue field.

public static FMOD_STUDIO_USER_PROPERTY
calloc()

Returns a new FMOD_STUDIO_USER_PROPERTY instance allocated with memCalloc.

public static FMOD_STUDIO_USER_PROPERTY.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new FMOD_STUDIO_USER_PROPERTY.Buffer instance allocated with memCalloc.

public static FMOD_STUDIO_USER_PROPERTY
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new FMOD_STUDIO_USER_PROPERTY instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static FMOD_STUDIO_USER_PROPERTY.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new FMOD_STUDIO_USER_PROPERTY.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected FMOD_STUDIO_USER_PROPERTY
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static FMOD_STUDIO_USER_PROPERTY
create()

Returns a new FMOD_STUDIO_USER_PROPERTY instance allocated with BufferUtils.

public static FMOD_STUDIO_USER_PROPERTY
create(long address)

Returns a new FMOD_STUDIO_USER_PROPERTY instance for the specified memory address.

public static FMOD_STUDIO_USER_PROPERTY.Buffer
create(int
the buffer capacity
capacity
)

Returns a new FMOD_STUDIO_USER_PROPERTY.Buffer instance allocated with BufferUtils.

public static FMOD_STUDIO_USER_PROPERTY.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a FMOD_STUDIO_USER_PROPERTY.Buffer instance at the specified memory.

public static FMOD_STUDIO_USER_PROPERTY
createSafe(long address)

Like create, but returns null if address is NULL.

public static FMOD_STUDIO_USER_PROPERTY.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public float

Returns:

the value of the floatvalue field.
floatvalue
()

public FMOD_STUDIO_USER_PROPERTY
floatvalue(float value)

Sets the specified value to the floatvalue field.

public int

Returns:

the value of the intvalue field.
intvalue
()

public FMOD_STUDIO_USER_PROPERTY
intvalue(int value)

Sets the specified value to the intvalue field.

public static FMOD_STUDIO_USER_PROPERTY
malloc()

Returns a new FMOD_STUDIO_USER_PROPERTY instance allocated with memAlloc.

public static FMOD_STUDIO_USER_PROPERTY.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new FMOD_STUDIO_USER_PROPERTY.Buffer instance allocated with memAlloc.

public static FMOD_STUDIO_USER_PROPERTY
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new FMOD_STUDIO_USER_PROPERTY instance allocated on the specified MemoryStack.

public static FMOD_STUDIO_USER_PROPERTY.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public ByteBuffer

Returns:

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

public FMOD_STUDIO_USER_PROPERTY
name(ByteBuffer value)

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

public String

Returns:

the null-terminated string pointed to by the name field.
nameString
()

public static int
nboolvalue(long struct)

Unsafe version of boolvalue.

public static void
nboolvalue(long struct, int value)

Unsafe version of boolvalue.

public static float
nfloatvalue(long struct)

Unsafe version of floatvalue.

public static void
nfloatvalue(long struct, float value)

Unsafe version of floatvalue.

public static int
nintvalue(long struct)

Unsafe version of intvalue.

public static void
nintvalue(long struct, int value)

Unsafe version of intvalue.

public static ByteBuffer
nname(long struct)

Unsafe version of name.

public static void
nname(long struct, ByteBuffer value)

Unsafe version of name.

public static String
nnameString(long struct)

Unsafe version of nameString.

public static ByteBuffer
nstringvalue(long struct)

Unsafe version of stringvalue.

public static void
nstringvalue(long struct, ByteBuffer value)

Unsafe version of stringvalue.

public static String
nstringvalueString(long struct)

Unsafe version of stringvalueString.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public FMOD_STUDIO_USER_PROPERTY

Returns:

this struct
set
(FMOD_STUDIO_USER_PROPERTY
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the stringvalue field.
stringvalue
()

public FMOD_STUDIO_USER_PROPERTY
stringvalue(ByteBuffer value)

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

public String

Returns:

the null-terminated string pointed to by the stringvalue field.
stringvalueString
()

public int

Returns:

the value of the type field.
type
()

public FMOD_STUDIO_USER_PROPERTY
type(int value)

Sets the specified value to the type field.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

BOOLVALUEback to summary
public static final int BOOLVALUE

The struct member offsets.

FLOATVALUEback to summary
public static final int FLOATVALUE

The struct member offsets.

INTVALUEback to summary
public static final int INTVALUE

The struct member offsets.

NAMEback to summary
public static final int NAME

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STRINGVALUEback to summary
public static final int STRINGVALUE

The struct member offsets.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

FMOD_STUDIO_USER_PROPERTYback to summary
protected FMOD_STUDIO_USER_PROPERTY(long address, ByteBuffer container)
FMOD_STUDIO_USER_PROPERTYback to summary
public FMOD_STUDIO_USER_PROPERTY(ByteBuffer container)

Creates a FMOD_STUDIO_USER_PROPERTY 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 Detail

boolvalueback to summary
public int boolvalue()
Returns:int

the value of the boolvalue field.

Annotations
@NativeType:FMOD_BOOL
boolvalueback to summary
public FMOD_STUDIO_USER_PROPERTY boolvalue(int value)

Sets the specified value to the boolvalue field.

callocback to summary
public static FMOD_STUDIO_USER_PROPERTY calloc()

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

callocback to summary
public static FMOD_STUDIO_USER_PROPERTY.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static FMOD_STUDIO_USER_PROPERTY calloc(MemoryStack stack)

Returns a new FMOD_STUDIO_USER_PROPERTY instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static FMOD_STUDIO_USER_PROPERTY.Buffer calloc(int capacity, MemoryStack stack)

Returns a new FMOD_STUDIO_USER_PROPERTY.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected FMOD_STUDIO_USER_PROPERTY create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static FMOD_STUDIO_USER_PROPERTY create()

Returns a new FMOD_STUDIO_USER_PROPERTY instance allocated with BufferUtils.

createback to summary
public static FMOD_STUDIO_USER_PROPERTY create(long address)

Returns a new FMOD_STUDIO_USER_PROPERTY instance for the specified memory address.

createback to summary
public static FMOD_STUDIO_USER_PROPERTY.Buffer create(int capacity)

Returns a new FMOD_STUDIO_USER_PROPERTY.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static FMOD_STUDIO_USER_PROPERTY.Buffer create(long address, int capacity)

Create a FMOD_STUDIO_USER_PROPERTY.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static FMOD_STUDIO_USER_PROPERTY createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static FMOD_STUDIO_USER_PROPERTY.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
floatvalueback to summary
public float floatvalue()
Returns:float

the value of the floatvalue field.

floatvalueback to summary
public FMOD_STUDIO_USER_PROPERTY floatvalue(float value)

Sets the specified value to the floatvalue field.

intvalueback to summary
public int intvalue()
Returns:int

the value of the intvalue field.

intvalueback to summary
public FMOD_STUDIO_USER_PROPERTY intvalue(int value)

Sets the specified value to the intvalue field.

mallocback to summary
public static FMOD_STUDIO_USER_PROPERTY malloc()

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

mallocback to summary
public static FMOD_STUDIO_USER_PROPERTY.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static FMOD_STUDIO_USER_PROPERTY malloc(MemoryStack stack)

Returns a new FMOD_STUDIO_USER_PROPERTY instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static FMOD_STUDIO_USER_PROPERTY.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nameback to summary
public ByteBuffer name()
Returns:ByteBuffer

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

Annotations
@NativeType:char const *
nameback to summary
public FMOD_STUDIO_USER_PROPERTY name(ByteBuffer value)

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

nameStringback to summary
public String nameString()
Returns:String

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

Annotations
@NativeType:char const *
nboolvalueback to summary
public static int nboolvalue(long struct)

Unsafe version of boolvalue.

nboolvalueback to summary
public static void nboolvalue(long struct, int value)

Unsafe version of boolvalue.

nfloatvalueback to summary
public static float nfloatvalue(long struct)

Unsafe version of floatvalue.

nfloatvalueback to summary
public static void nfloatvalue(long struct, float value)

Unsafe version of floatvalue.

nintvalueback to summary
public static int nintvalue(long struct)

Unsafe version of intvalue.

nintvalueback to summary
public static void nintvalue(long struct, int value)

Unsafe version of intvalue.

nnameback to summary
public static ByteBuffer nname(long struct)

Unsafe version of name.

nnameback to summary
public static void nname(long struct, ByteBuffer value)

Unsafe version of name.

nnameStringback to summary
public static String nnameString(long struct)

Unsafe version of nameString.

nstringvalueback to summary
public static ByteBuffer nstringvalue(long struct)

Unsafe version of stringvalue.

Annotations
@Nullable
nstringvalueback to summary
public static void nstringvalue(long struct, ByteBuffer value)

Unsafe version of stringvalue.

nstringvalueStringback to summary
public static String nstringvalueString(long struct)

Unsafe version of stringvalueString.

Annotations
@Nullable
ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

setback to summary
public FMOD_STUDIO_USER_PROPERTY set(FMOD_STUDIO_USER_PROPERTY src)

Copies the specified struct data to this struct.

Parameters
src:FMOD_STUDIO_USER_PROPERTY

the source struct

Returns:FMOD_STUDIO_USER_PROPERTY

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
stringvalueback to summary
public ByteBuffer stringvalue()
Returns:ByteBuffer

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

Annotations
@Nullable
@NativeType:char const *
stringvalueback to summary
public FMOD_STUDIO_USER_PROPERTY stringvalue(ByteBuffer value)

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

stringvalueStringback to summary
public String stringvalueString()
Returns:String

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

Annotations
@Nullable
@NativeType:char const *
typeback to summary
public int type()
Returns:int

the value of the type field.

Annotations
@NativeType:FMOD_STUDIO_USER_PROPERTY_TYPE
typeback to summary
public FMOD_STUDIO_USER_PROPERTY type(int value)

Sets the specified value to the type field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.fmod back to summary

public Class FMOD_STUDIO_USER_PROPERTY.Buffer

extends StructBuffer<FMOD_STUDIO_USER_PROPERTY, FMOD_STUDIO_USER_PROPERTY.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of FMOD_STUDIO_USER_PROPERTY structs.

Field Summary

Modifier and TypeField and Description
private static final FMOD_STUDIO_USER_PROPERTY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new FMOD_STUDIO_USER_PROPERTY.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the boolvalue field.
boolvalue
()

public FMOD_STUDIO_USER_PROPERTY.Buffer
boolvalue(int value)

Sets the specified value to the boolvalue field.

public float

Returns:

the value of the floatvalue field.
floatvalue
()

public FMOD_STUDIO_USER_PROPERTY.Buffer
floatvalue(float value)

Sets the specified value to the floatvalue field.

protected FMOD_STUDIO_USER_PROPERTY
public int

Returns:

the value of the intvalue field.
intvalue
()

public FMOD_STUDIO_USER_PROPERTY.Buffer
intvalue(int value)

Sets the specified value to the intvalue field.

public ByteBuffer

Returns:

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

public FMOD_STUDIO_USER_PROPERTY.Buffer
name(ByteBuffer value)

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

public String

Returns:

the null-terminated string pointed to by the name field.
nameString
()

protected FMOD_STUDIO_USER_PROPERTY.Buffer
public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the stringvalue field.
stringvalue
()

public FMOD_STUDIO_USER_PROPERTY.Buffer
stringvalue(ByteBuffer value)

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

public String

Returns:

the null-terminated string pointed to by the stringvalue field.
stringvalueString
()

public int

Returns:

the value of the type field.
type
()

public FMOD_STUDIO_USER_PROPERTY.Buffer
type(int value)

Sets the specified value to the type field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final FMOD_STUDIO_USER_PROPERTY ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new FMOD_STUDIO_USER_PROPERTY.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by FMOD_STUDIO_USER_PROPERTY#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

boolvalueback to summary
public int boolvalue()
Returns:int

the value of the boolvalue field.

Annotations
@NativeType:FMOD_BOOL
boolvalueback to summary
public FMOD_STUDIO_USER_PROPERTY.Buffer boolvalue(int value)

Sets the specified value to the boolvalue field.

floatvalueback to summary
public float floatvalue()
Returns:float

the value of the floatvalue field.

floatvalueback to summary
public FMOD_STUDIO_USER_PROPERTY.Buffer floatvalue(float value)

Sets the specified value to the floatvalue field.

getElementFactoryback to summary
protected FMOD_STUDIO_USER_PROPERTY getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
intvalueback to summary
public int intvalue()
Returns:int

the value of the intvalue field.

intvalueback to summary
public FMOD_STUDIO_USER_PROPERTY.Buffer intvalue(int value)

Sets the specified value to the intvalue field.

nameback to summary
public ByteBuffer name()
Returns:ByteBuffer

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

Annotations
@NativeType:char const *
nameback to summary
public FMOD_STUDIO_USER_PROPERTY.Buffer name(ByteBuffer value)

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

nameStringback to summary
public String nameString()
Returns:String

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

Annotations
@NativeType:char const *
selfback to summary
protected FMOD_STUDIO_USER_PROPERTY.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
stringvalueback to summary
public ByteBuffer stringvalue()
Returns:ByteBuffer

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

Annotations
@Nullable
@NativeType:char const *
stringvalueback to summary
public FMOD_STUDIO_USER_PROPERTY.Buffer stringvalue(ByteBuffer value)

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

stringvalueStringback to summary
public String stringvalueString()
Returns:String

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

Annotations
@Nullable
@NativeType:char const *
typeback to summary
public int type()
Returns:int

the value of the type field.

Annotations
@NativeType:FMOD_STUDIO_USER_PROPERTY_TYPE
typeback to summary
public FMOD_STUDIO_USER_PROPERTY.Buffer type(int value)

Sets the specified value to the type field.