Top Description Inners Fields Constructors Methods
org.lwjgl.fmod

public Class FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES

extends Struct<FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES>
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_PROGRAMMER_SOUND_PROPERTIES {
    char const * name;
    FMOD_SOUND * sound;
    int subsoundIndex;
}

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
NAME

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SOUND

The struct member offsets.

public static final int
SUBSOUNDINDEX

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
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.

Method Summary

Modifier and TypeMethod and Description
public static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES
calloc()

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance allocated with memCalloc.

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

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer instance allocated with memCalloc.

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

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

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

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

protected FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES
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_PROGRAMMER_SOUND_PROPERTIES
create()

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance allocated with BufferUtils.

public static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES
create(long address)

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance for the specified memory address.

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

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer instance allocated with BufferUtils.

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

Create a FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer instance at the specified memory.

public static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES
malloc()

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance allocated with memAlloc.

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

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer instance allocated with memAlloc.

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

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance allocated on the specified MemoryStack.

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

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.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_PROGRAMMER_SOUND_PROPERTIES
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 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 long
nsound(long struct)

Unsafe version of sound.

public static void
nsound(long struct, long value)

Unsafe version of sound.

public static int
nsubsoundIndex(long struct)

Unsafe version of subsoundIndex.

public static void
nsubsoundIndex(long struct, int value)

Unsafe version of subsoundIndex.

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

Initializes this struct with the specified values.

public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES

Returns:

this struct
set
(FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES
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 long

Returns:

the value of the sound field.
sound
()

public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES
sound(long value)

Sets the specified value to the sound field.

public int

Returns:

the value of the subsoundIndex field.
subsoundIndex
()

public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES
subsoundIndex(int value)

Sets the specified value to the subsoundIndex 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.

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.

SOUNDback to summary
public static final int SOUND

The struct member offsets.

SUBSOUNDINDEXback to summary
public static final int SUBSOUNDINDEX

The struct member offsets.

Constructor Detail

FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIESback to summary
protected FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES(long address, ByteBuffer container)
FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIESback to summary
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 Detail

callocback to summary
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.

callocback to summary
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:int

the buffer capacity

callocback to summary
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:MemoryStack

the stack from which to allocate

callocback to summary
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:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES 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_PROGRAMMER_SOUND_PROPERTIES create()

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance allocated with BufferUtils.

createback to summary
public static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES create(long address)

Returns a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES instance for the specified memory address.

createback to summary
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:int

the buffer capacity

createback to summary
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:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
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.

mallocback to summary
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:int

the buffer capacity

mallocback to summary
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:MemoryStack

the stack from which to allocate

mallocback to summary
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: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_PROGRAMMER_SOUND_PROPERTIES 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 *
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.

nsoundback to summary
public static long nsound(long struct)

Unsafe version of sound.

nsoundback to summary
public static void nsound(long struct, long value)

Unsafe version of sound.

nsubsoundIndexback to summary
public static int nsubsoundIndex(long struct)

Unsafe version of subsoundIndex.

nsubsoundIndexback to summary
public static void nsubsoundIndex(long struct, int value)

Unsafe version of subsoundIndex.

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

Initializes this struct with the specified values.

setback to summary
public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES set(FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES src)

Copies the specified struct data to this struct.

Parameters
src:FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES

the source struct

Returns:FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES

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
soundback to summary
public long sound()
Returns:long

the value of the sound field.

Annotations
@NativeType:FMOD_SOUND *
soundback to summary
public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES sound(long value)

Sets the specified value to the sound field.

subsoundIndexback to summary
public int subsoundIndex()
Returns:int

the value of the subsoundIndex field.

subsoundIndexback to summary
public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES subsoundIndex(int value)

Sets the specified value to the subsoundIndex 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_PROGRAMMER_SOUND_PROPERTIES.Buffer

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

An array of FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES structs.

Field Summary

Modifier and TypeField and Description
private static final FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.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
protected FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES
public ByteBuffer

Returns:

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

public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.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_PROGRAMMER_SOUND_PROPERTIES.Buffer
public long

Returns:

the value of the sound field.
sound
()

public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer
sound(long value)

Sets the specified value to the sound field.

public int

Returns:

the value of the subsoundIndex field.
subsoundIndex
()

public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer
subsoundIndex(int value)

Sets the specified value to the subsoundIndex field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES getElementFactory()

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

Annotations
@Override
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_PROGRAMMER_SOUND_PROPERTIES.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_PROGRAMMER_SOUND_PROPERTIES.Buffer self()

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

Annotations
@Override
soundback to summary
public long sound()
Returns:long

the value of the sound field.

Annotations
@NativeType:FMOD_SOUND *
soundback to summary
public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer sound(long value)

Sets the specified value to the sound field.

subsoundIndexback to summary
public int subsoundIndex()
Returns:int

the value of the subsoundIndex field.

subsoundIndexback to summary
public FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.Buffer subsoundIndex(int value)

Sets the specified value to the subsoundIndex field.