Top Description Inners Fields Constructors Methods
org.lwjgl.fmod

public Class FMOD_TAG

extends Struct<FMOD_TAG>
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_TAG {
    FMOD_TAGTYPE type;
    FMOD_TAGDATATYPE datatype;
    char * name;
    void * data;
    unsigned int datalen;
    FMOD_BOOL updated;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
FMOD_TAG.Buffer

An array of FMOD_TAG structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DATA

The struct member offsets.

public static final int
DATALEN

The struct member offsets.

public static final int
DATATYPE

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
TYPE

The struct member offsets.

public static final int
UPDATED

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
FMOD_TAG(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static FMOD_TAG
calloc()

Returns a new FMOD_TAG instance allocated with memCalloc.

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

Returns a new FMOD_TAG.Buffer instance allocated with memCalloc.

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

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

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

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

protected FMOD_TAG
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_TAG
create()

Returns a new FMOD_TAG instance allocated with BufferUtils.

public static FMOD_TAG
create(long address)

Returns a new FMOD_TAG instance for the specified memory address.

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

Returns a new FMOD_TAG.Buffer instance allocated with BufferUtils.

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

Create a FMOD_TAG.Buffer instance at the specified memory.

public static FMOD_TAG
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the data field.
data
()

public FMOD_TAG
data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the data field.

public int

Returns:

the value of the datalen field.
datalen
()

public int

Returns:

the value of the datatype field.
datatype
()

public FMOD_TAG
datatype(int value)

Sets the specified value to the datatype field.

public static FMOD_TAG
malloc()

Returns a new FMOD_TAG instance allocated with memAlloc.

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

Returns a new FMOD_TAG.Buffer instance allocated with memAlloc.

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

Returns a new FMOD_TAG instance allocated on the specified MemoryStack.

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

Returns a new FMOD_TAG.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_TAG
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
ndata(long struct)

Unsafe version of data.

public static void
ndata(long struct, ByteBuffer value)

Unsafe version of data.

public static int
ndatalen(long struct)

Unsafe version of datalen.

public static void
ndatalen(long struct, int value)

Sets the specified value to the datalen field of the specified struct.

public static int
ndatatype(long struct)

Unsafe version of datatype.

public static void
ndatatype(long struct, int value)

Unsafe version of datatype.

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 int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public static int
nupdated(long struct)

Unsafe version of updated.

public static void
nupdated(long struct, int value)

Unsafe version of updated.

public FMOD_TAG
set(int type, int datatype, ByteBuffer name, ByteBuffer data, int updated)

Initializes this struct with the specified values.

public FMOD_TAG

Returns:

this struct
set
(FMOD_TAG
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 int

Returns:

the value of the type field.
type
()

public FMOD_TAG
type(int value)

Sets the specified value to the type field.

public int

Returns:

the value of the updated field.
updated
()

public FMOD_TAG
updated(int value)

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

DATAback to summary
public static final int DATA

The struct member offsets.

DATALENback to summary
public static final int DATALEN

The struct member offsets.

DATATYPEback to summary
public static final int DATATYPE

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.

TYPEback to summary
public static final int TYPE

The struct member offsets.

UPDATEDback to summary
public static final int UPDATED

The struct member offsets.

Constructor Detail

FMOD_TAGback to summary
protected FMOD_TAG(long address, ByteBuffer container)
FMOD_TAGback to summary
public FMOD_TAG(ByteBuffer container)

Creates a FMOD_TAG 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_TAG calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static FMOD_TAG calloc(MemoryStack stack)

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

Returns a new FMOD_TAG.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_TAG 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_TAG create()

Returns a new FMOD_TAG instance allocated with BufferUtils.

createback to summary
public static FMOD_TAG create(long address)

Returns a new FMOD_TAG instance for the specified memory address.

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

Returns a new FMOD_TAG.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a FMOD_TAG.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static FMOD_TAG createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
databack to summary
public ByteBuffer data()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the data field.

Annotations
@NativeType:void *
databack to summary
public FMOD_TAG data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the data field.

datalenback to summary
public int datalen()
Returns:int

the value of the datalen field.

Annotations
@NativeType:unsigned int
datatypeback to summary
public int datatype()
Returns:int

the value of the datatype field.

Annotations
@NativeType:FMOD_TAGDATATYPE
datatypeback to summary
public FMOD_TAG datatype(int value)

Sets the specified value to the datatype field.

mallocback to summary
public static FMOD_TAG malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static FMOD_TAG malloc(MemoryStack stack)

Returns a new FMOD_TAG instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new FMOD_TAG.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 *
nameback to summary
public FMOD_TAG 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 *
ndataback to summary
public static ByteBuffer ndata(long struct)

Unsafe version of data.

ndataback to summary
public static void ndata(long struct, ByteBuffer value)

Unsafe version of data.

ndatalenback to summary
public static int ndatalen(long struct)

Unsafe version of datalen.

ndatalenback to summary
public static void ndatalen(long struct, int value)

Sets the specified value to the datalen field of the specified struct.

ndatatypeback to summary
public static int ndatatype(long struct)

Unsafe version of datatype.

ndatatypeback to summary
public static void ndatatype(long struct, int value)

Unsafe version of datatype.

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.

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.

nupdatedback to summary
public static int nupdated(long struct)

Unsafe version of updated.

nupdatedback to summary
public static void nupdated(long struct, int value)

Unsafe version of updated.

setback to summary
public FMOD_TAG set(int type, int datatype, ByteBuffer name, ByteBuffer data, int updated)

Initializes this struct with the specified values.

setback to summary
public FMOD_TAG set(FMOD_TAG src)

Copies the specified struct data to this struct.

Parameters
src:FMOD_TAG

the source struct

Returns:FMOD_TAG

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
typeback to summary
public int type()
Returns:int

the value of the type field.

Annotations
@NativeType:FMOD_TAGTYPE
typeback to summary
public FMOD_TAG type(int value)

Sets the specified value to the type field.

updatedback to summary
public int updated()
Returns:int

the value of the updated field.

Annotations
@NativeType:FMOD_BOOL
updatedback to summary
public FMOD_TAG updated(int value)

Sets the specified value to the updated 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_TAG.Buffer

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

An array of FMOD_TAG structs.

Field Summary

Modifier and TypeField and Description
private static final FMOD_TAG

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new FMOD_TAG.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 ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the data field.
data
()

public FMOD_TAG.Buffer
data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the data field.

public int

Returns:

the value of the datalen field.
datalen
()

public int

Returns:

the value of the datatype field.
datatype
()

public FMOD_TAG.Buffer
datatype(int value)

Sets the specified value to the datatype field.

protected FMOD_TAG
public ByteBuffer

Returns:

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

public FMOD_TAG.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_TAG.Buffer
public int

Returns:

the value of the type field.
type
()

public FMOD_TAG.Buffer
type(int value)

Sets the specified value to the type field.

public int

Returns:

the value of the updated field.
updated
()

public FMOD_TAG.Buffer
updated(int value)

Sets the specified value to the updated field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final FMOD_TAG ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new FMOD_TAG.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_TAG#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

databack to summary
public ByteBuffer data()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the data field.

Annotations
@NativeType:void *
databack to summary
public FMOD_TAG.Buffer data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the data field.

datalenback to summary
public int datalen()
Returns:int

the value of the datalen field.

Annotations
@NativeType:unsigned int
datatypeback to summary
public int datatype()
Returns:int

the value of the datatype field.

Annotations
@NativeType:FMOD_TAGDATATYPE
datatypeback to summary
public FMOD_TAG.Buffer datatype(int value)

Sets the specified value to the datatype field.

getElementFactoryback to summary
protected FMOD_TAG 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 *
nameback to summary
public FMOD_TAG.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 *
selfback to summary
protected FMOD_TAG.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the type field.

Annotations
@NativeType:FMOD_TAGTYPE
typeback to summary
public FMOD_TAG.Buffer type(int value)

Sets the specified value to the type field.

updatedback to summary
public int updated()
Returns:int

the value of the updated field.

Annotations
@NativeType:FMOD_BOOL
updatedback to summary
public FMOD_TAG.Buffer updated(int value)

Sets the specified value to the updated field.