Top Description Inners Fields Constructors Methods
org.lwjgl.assimp

public Class AIMetaData

extends Struct<AIMetaData>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct aiMetadata
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


struct aiMetadata {
    unsigned int mNumProperties;
    struct aiString * mKeys;
    struct aiMetadataEntry * mValues;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
AIMetaData.Buffer

An array of AIMetaData structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MKEYS

The struct member offsets.

public static final int
MNUMPROPERTIES

The struct member offsets.

public static final int
MVALUES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
AIMetaData(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static AIMetaData
calloc()

Returns a new AIMetaData instance allocated with memCalloc.

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

Returns a new AIMetaData.Buffer instance allocated with memCalloc.

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

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

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

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

public static AIMetaData
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static AIMetaData
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static AIMetaData.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static AIMetaData.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected AIMetaData
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 AIMetaData
create()

Returns a new AIMetaData instance allocated with BufferUtils.

public static AIMetaData
create(long address)

Returns a new AIMetaData instance for the specified memory address.

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

Returns a new AIMetaData.Buffer instance allocated with BufferUtils.

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

Create a AIMetaData.Buffer instance at the specified memory.

public static AIMetaData
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static AIMetaData
malloc()

Returns a new AIMetaData instance allocated with memAlloc.

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

Returns a new AIMetaData.Buffer instance allocated with memAlloc.

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

Returns a new AIMetaData instance allocated on the specified MemoryStack.

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

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

public static AIMetaData
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static AIMetaData
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static AIMetaData.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static AIMetaData.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public AIString.Buffer
mKeys()

Arrays of keys, may not be NULL.

public AIMetaData
mKeys(AIString.Buffer value)

Sets the address of the specified AIString.Buffer to the mKeys field.

public int
mNumProperties()

Length of the mKeys and mValues arrays, respectively

public AIMetaData
mNumProperties(int value)

Sets the specified value to the mNumProperties field.

public AIMetaDataEntry.Buffer
mValues()

Arrays of values, may not be NULL.

public AIMetaData
mValues(AIMetaDataEntry.Buffer value)

Sets the address of the specified AIMetaDataEntry.Buffer to the mValues field.

public static AIString.Buffer
nmKeys(long struct)

Unsafe version of mKeys.

public static void
nmKeys(long struct, AIString.Buffer value)

Unsafe version of mKeys.

public static int
nmNumProperties(long struct)

Unsafe version of mNumProperties.

public static void
nmNumProperties(long struct, int value)

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

public static AIMetaDataEntry.Buffer
nmValues(long struct)

Unsafe version of mValues.

public static void
nmValues(long struct, AIMetaDataEntry.Buffer value)

Unsafe version of mValues.

public AIMetaData
set(int mNumProperties, AIString.Buffer mKeys, AIMetaDataEntry.Buffer mValues)

Initializes this struct with the specified values.

public AIMetaData

Returns:

this struct
set
(AIMetaData
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 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.

MKEYSback to summary
public static final int MKEYS

The struct member offsets.

MNUMPROPERTIESback to summary
public static final int MNUMPROPERTIES

The struct member offsets.

MVALUESback to summary
public static final int MVALUES

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

AIMetaDataback to summary
protected AIMetaData(long address, ByteBuffer container)
AIMetaDataback to summary
public AIMetaData(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static AIMetaData calloc(MemoryStack stack)

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

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

callocStackback to summary
public static AIMetaData callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static AIMetaData callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static AIMetaData.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static AIMetaData.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected AIMetaData 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 AIMetaData create()

Returns a new AIMetaData instance allocated with BufferUtils.

createback to summary
public static AIMetaData create(long address)

Returns a new AIMetaData instance for the specified memory address.

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

Returns a new AIMetaData.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a AIMetaData.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static AIMetaData createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static AIMetaData malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static AIMetaData malloc(MemoryStack stack)

Returns a new AIMetaData instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static AIMetaData mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static AIMetaData mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static AIMetaData.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static AIMetaData.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mKeysback to summary
public AIString.Buffer mKeys()

Arrays of keys, may not be NULL. Entries in this array may not be NULL as well.

Annotations
@NativeType:struct aiString *
mKeysback to summary
public AIMetaData mKeys(AIString.Buffer value)

Sets the address of the specified AIString.Buffer to the mKeys field.

mNumPropertiesback to summary
public int mNumProperties()

Length of the mKeys and mValues arrays, respectively

Annotations
@NativeType:unsigned int
mNumPropertiesback to summary
public AIMetaData mNumProperties(int value)

Sets the specified value to the mNumProperties field.

mValuesback to summary
public AIMetaDataEntry.Buffer mValues()

Arrays of values, may not be NULL. Entries in this array may be NULL if the corresponding property key has no assigned value.

Annotations
@NativeType:struct aiMetadataEntry *
mValuesback to summary
public AIMetaData mValues(AIMetaDataEntry.Buffer value)

Sets the address of the specified AIMetaDataEntry.Buffer to the mValues field.

nmKeysback to summary
public static AIString.Buffer nmKeys(long struct)

Unsafe version of mKeys.

nmKeysback to summary
public static void nmKeys(long struct, AIString.Buffer value)

Unsafe version of mKeys.

nmNumPropertiesback to summary
public static int nmNumProperties(long struct)

Unsafe version of mNumProperties.

nmNumPropertiesback to summary
public static void nmNumProperties(long struct, int value)

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

nmValuesback to summary
public static AIMetaDataEntry.Buffer nmValues(long struct)

Unsafe version of mValues.

nmValuesback to summary
public static void nmValues(long struct, AIMetaDataEntry.Buffer value)

Unsafe version of mValues.

setback to summary
public AIMetaData set(int mNumProperties, AIString.Buffer mKeys, AIMetaDataEntry.Buffer mValues)

Initializes this struct with the specified values.

setback to summary
public AIMetaData set(AIMetaData src)

Copies the specified struct data to this struct.

Parameters
src:AIMetaData

the source struct

Returns:AIMetaData

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
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.assimp back to summary

public Class AIMetaData.Buffer

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

An array of AIMetaData structs.

Field Summary

Modifier and TypeField and Description
private static final AIMetaData

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new AIMetaData.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 AIMetaData
public AIString.Buffer

Returns:

a AIString.Buffer view of the struct array pointed to by the AIMetaData#mKeys field.
mKeys
()

public AIMetaData.Buffer
mKeys(AIString.Buffer value)

Sets the address of the specified AIString.Buffer to the AIMetaData#mKeys field.

public int

Returns:

the value of the AIMetaData#mNumProperties field.
mNumProperties
()

public AIMetaData.Buffer
mNumProperties(int value)

Sets the specified value to the AIMetaData#mNumProperties field.

public AIMetaDataEntry.Buffer

Returns:

a AIMetaDataEntry.Buffer view of the struct array pointed to by the AIMetaData#mValues field.
mValues
()

public AIMetaData.Buffer
mValues(AIMetaDataEntry.Buffer value)

Sets the address of the specified AIMetaDataEntry.Buffer to the AIMetaData#mValues field.

protected AIMetaData.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final AIMetaData ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new AIMetaData.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 AIMetaData#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 AIMetaData getElementFactory()

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

Annotations
@Override
mKeysback to summary
public AIString.Buffer mKeys()
Returns:AIString.Buffer

a AIString.Buffer view of the struct array pointed to by the AIMetaData#mKeys field.

Annotations
@NativeType:struct aiString *
mKeysback to summary
public AIMetaData.Buffer mKeys(AIString.Buffer value)

Sets the address of the specified AIString.Buffer to the AIMetaData#mKeys field.

mNumPropertiesback to summary
public int mNumProperties()
Returns:int

the value of the AIMetaData#mNumProperties field.

Annotations
@NativeType:unsigned int
mNumPropertiesback to summary
public AIMetaData.Buffer mNumProperties(int value)

Sets the specified value to the AIMetaData#mNumProperties field.

mValuesback to summary
public AIMetaDataEntry.Buffer mValues()
Returns:AIMetaDataEntry.Buffer

a AIMetaDataEntry.Buffer view of the struct array pointed to by the AIMetaData#mValues field.

Annotations
@NativeType:struct aiMetadataEntry *
mValuesback to summary
public AIMetaData.Buffer mValues(AIMetaDataEntry.Buffer value)

Sets the address of the specified AIMetaDataEntry.Buffer to the AIMetaData#mValues field.

selfback to summary
protected AIMetaData.Buffer self()

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

Annotations
@Override