Top Description Inners Fields Constructors Methods
org.lwjgl.assimp

public Class AIMeshAnim

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

Describes vertex-based animations for a single mesh or a group of meshes. Meshes carry the animation data for each frame in their AIMesh::mAnimMeshes array. The purpose of aiMeshAnim is to define keyframes linking each mesh attachment to a particular point in time.

Layout


struct aiMeshAnim {
    struct aiString mName;
    unsigned int mNumKeys;
    struct aiMeshKey * mKeys;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
AIMeshAnim.Buffer

An array of AIMeshAnim 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
MNAME

The struct member offsets.

public static final int
MNUMKEYS

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
AIMeshAnim(long address, ByteBuffer container)

public
AIMeshAnim(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static AIMeshAnim
calloc()

Returns a new AIMeshAnim instance allocated with memCalloc.

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

Returns a new AIMeshAnim.Buffer instance allocated with memCalloc.

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

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

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

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

public static AIMeshAnim
callocStack()

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

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

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

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

Returns a new AIMeshAnim instance allocated with BufferUtils.

public static AIMeshAnim
create(long address)

Returns a new AIMeshAnim instance for the specified memory address.

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

Returns a new AIMeshAnim.Buffer instance allocated with BufferUtils.

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

Create a AIMeshAnim.Buffer instance at the specified memory.

public static AIMeshAnim
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static AIMeshAnim
malloc()

Returns a new AIMeshAnim instance allocated with memAlloc.

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

Returns a new AIMeshAnim.Buffer instance allocated with memAlloc.

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

Returns a new AIMeshAnim instance allocated on the specified MemoryStack.

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

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

public static AIMeshAnim
mallocStack()

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

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

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

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

Key frames of the animation.

public AIMeshAnim
mKeys(AIMeshKey.Buffer value)

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

public AIString
mName()

Name of the mesh to be animated.

public AIMeshAnim
mName(AIString value)

Copies the specified AIString to the mName field.

public AIMeshAnim
mName(Consumer<AIString> consumer)

Passes the mName field to the specified Consumer.

public int
mNumKeys()

Size of the mKeys array.

public static AIMeshKey.Buffer
nmKeys(long struct)

Unsafe version of mKeys.

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

Unsafe version of mKeys.

public static AIString
nmName(long struct)

Unsafe version of mName.

public static void
nmName(long struct, AIString value)

Unsafe version of mName.

public static int
nmNumKeys(long struct)

Unsafe version of mNumKeys.

public static void
nmNumKeys(long struct, int value)

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

public AIMeshAnim
set(AIString mName, AIMeshKey.Buffer mKeys)

Initializes this struct with the specified values.

public AIMeshAnim

Returns:

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

MNAMEback to summary
public static final int MNAME

The struct member offsets.

MNUMKEYSback to summary
public static final int MNUMKEYS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

AIMeshAnimback to summary
protected AIMeshAnim(long address, ByteBuffer container)
AIMeshAnimback to summary
public AIMeshAnim(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static AIMeshAnim calloc(MemoryStack stack)

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

Returns a new AIMeshAnim.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 AIMeshAnim callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static AIMeshAnim.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 AIMeshAnim 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 AIMeshAnim create()

Returns a new AIMeshAnim instance allocated with BufferUtils.

createback to summary
public static AIMeshAnim create(long address)

Returns a new AIMeshAnim instance for the specified memory address.

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

Returns a new AIMeshAnim.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a AIMeshAnim.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static AIMeshAnim createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static AIMeshAnim malloc(MemoryStack stack)

Returns a new AIMeshAnim instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new AIMeshAnim.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 AIMeshAnim mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static AIMeshAnim.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 AIMeshKey.Buffer mKeys()

Key frames of the animation. May not be NULL.

Annotations
@NativeType:struct aiMeshKey *
mKeysback to summary
public AIMeshAnim mKeys(AIMeshKey.Buffer value)

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

mNameback to summary
public AIString mName()

Name of the mesh to be animated. An empty string is not allowed, animated meshes need to be named (not necessarily uniquely, the name can basically serve as wildcard to select a group of meshes with similar animation setup)

Annotations
@NativeType:struct aiString
mNameback to summary
public AIMeshAnim mName(AIString value)

Copies the specified AIString to the mName field.

mNameback to summary
public AIMeshAnim mName(Consumer<AIString> consumer)

Passes the mName field to the specified Consumer.

mNumKeysback to summary
public int mNumKeys()

Size of the mKeys array. Must be 1, at least.

Annotations
@NativeType:unsigned int
nmKeysback to summary
public static AIMeshKey.Buffer nmKeys(long struct)

Unsafe version of mKeys.

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

Unsafe version of mKeys.

nmNameback to summary
public static AIString nmName(long struct)

Unsafe version of mName.

nmNameback to summary
public static void nmName(long struct, AIString value)

Unsafe version of mName.

nmNumKeysback to summary
public static int nmNumKeys(long struct)

Unsafe version of mNumKeys.

nmNumKeysback to summary
public static void nmNumKeys(long struct, int value)

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

setback to summary
public AIMeshAnim set(AIString mName, AIMeshKey.Buffer mKeys)

Initializes this struct with the specified values.

setback to summary
public AIMeshAnim set(AIMeshAnim src)

Copies the specified struct data to this struct.

Parameters
src:AIMeshAnim

the source struct

Returns:AIMeshAnim

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 AIMeshAnim.Buffer

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

An array of AIMeshAnim structs.

Field Summary

Modifier and TypeField and Description
private static final AIMeshAnim

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new AIMeshAnim.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 AIMeshAnim
public AIMeshKey.Buffer

Returns:

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

public AIMeshAnim.Buffer
mKeys(AIMeshKey.Buffer value)

Sets the address of the specified AIMeshKey.Buffer to the AIMeshAnim#mKeys field.

public AIString

Returns:

a AIString view of the AIMeshAnim#mName field.
mName
()

public AIMeshAnim.Buffer
mName(AIString value)

Copies the specified AIString to the AIMeshAnim#mName field.

public AIMeshAnim.Buffer
mName(Consumer<AIString> consumer)

Passes the AIMeshAnim#mName field to the specified Consumer.

public int

Returns:

the value of the AIMeshAnim#mNumKeys field.
mNumKeys
()

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

Field Detail

ELEMENT_FACTORYback to summary
private static final AIMeshAnim ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

a AIMeshKey.Buffer view of the struct array pointed to by the AIMeshAnim#mKeys field.

Annotations
@NativeType:struct aiMeshKey *
mKeysback to summary
public AIMeshAnim.Buffer mKeys(AIMeshKey.Buffer value)

Sets the address of the specified AIMeshKey.Buffer to the AIMeshAnim#mKeys field.

mNameback to summary
public AIString mName()
Returns:AIString

a AIString view of the AIMeshAnim#mName field.

Annotations
@NativeType:struct aiString
mNameback to summary
public AIMeshAnim.Buffer mName(AIString value)

Copies the specified AIString to the AIMeshAnim#mName field.

mNameback to summary
public AIMeshAnim.Buffer mName(Consumer<AIString> consumer)

Passes the AIMeshAnim#mName field to the specified Consumer.

mNumKeysback to summary
public int mNumKeys()
Returns:int

the value of the AIMeshAnim#mNumKeys field.

Annotations
@NativeType:unsigned int
selfback to summary
protected AIMeshAnim.Buffer self()

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

Annotations
@Override