Top Description Inners Fields Constructors Methods
org.lwjgl.assimp

public Class AIFace

extends Struct<AIFace>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct aiFace
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
A single face in a mesh, referring to multiple vertices.

If mNumIndices is 3, we call the face 'triangle', for mNumIndices > 3 it's called 'polygon' (hey, that's just a definition!).

AIMesh::mPrimitiveTypes can be queried to quickly examine which types of primitive are actually present in a mesh. The Process_SortByPType flag executes a special post-processing algorithm which splits meshes with *different* primitive types mixed up (e.g. lines and triangles) in several 'clean' submeshes. Furthermore there is a configuration option (Assimp#AI_CONFIG_PP_SBP_REMOVE) to force Process_SortByPType to remove specific kinds of primitives from the imported scene, completely and forever.

Layout


struct aiFace {
    unsigned int mNumIndices;
    unsigned int * mIndices;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
AIFace.Buffer

An array of AIFace structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MINDICES

The struct member offsets.

public static final int
MNUMINDICES

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

public
AIFace(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static AIFace
calloc()

Returns a new AIFace instance allocated with memCalloc.

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

Returns a new AIFace.Buffer instance allocated with memCalloc.

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

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

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

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

public static AIFace
callocStack()

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

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

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

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

Returns a new AIFace instance allocated with BufferUtils.

public static AIFace
create(long address)

Returns a new AIFace instance for the specified memory address.

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

Returns a new AIFace.Buffer instance allocated with BufferUtils.

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

Create a AIFace.Buffer instance at the specified memory.

public static AIFace
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static AIFace
malloc()

Returns a new AIFace instance allocated with memAlloc.

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

Returns a new AIFace.Buffer instance allocated with memAlloc.

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

Returns a new AIFace instance allocated on the specified MemoryStack.

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

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

public static AIFace
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public IntBuffer
mIndices()

Pointer to the indices array.

public AIFace
mIndices(IntBuffer value)

Sets the address of the specified IntBuffer to the mIndices field.

public int
mNumIndices()

Number of indices defining this face.

public static IntBuffer
nmIndices(long struct)

Unsafe version of mIndices.

public static void
nmIndices(long struct, IntBuffer value)

Unsafe version of mIndices.

public static int
nmNumIndices(long struct)

Unsafe version of mNumIndices.

public static void
nmNumIndices(long struct, int value)

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

public AIFace

Returns:

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

MINDICESback to summary
public static final int MINDICES

The struct member offsets.

MNUMINDICESback to summary
public static final int MNUMINDICES

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

AIFaceback to summary
protected AIFace(long address, ByteBuffer container)
AIFaceback to summary
public AIFace(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static AIFace calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new AIFace instance allocated with BufferUtils.

createback to summary
public static AIFace create(long address)

Returns a new AIFace instance for the specified memory address.

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

Returns a new AIFace.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a AIFace.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static AIFace createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static AIFace malloc(MemoryStack stack)

Returns a new AIFace instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mIndicesback to summary
public IntBuffer mIndices()

Pointer to the indices array. Size of the array is given in numIndices.

Annotations
@NativeType:unsigned int *
mIndicesback to summary
public AIFace mIndices(IntBuffer value)

Sets the address of the specified IntBuffer to the mIndices field.

mNumIndicesback to summary
public int mNumIndices()

Number of indices defining this face. The maximum value for this member is Assimp#AI_MAX_FACE_INDICES.

Annotations
@NativeType:unsigned int
nmIndicesback to summary
public static IntBuffer nmIndices(long struct)

Unsafe version of mIndices.

nmIndicesback to summary
public static void nmIndices(long struct, IntBuffer value)

Unsafe version of mIndices.

nmNumIndicesback to summary
public static int nmNumIndices(long struct)

Unsafe version of mNumIndices.

nmNumIndicesback to summary
public static void nmNumIndices(long struct, int value)

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

setback to summary
public AIFace set(AIFace src)

Copies the specified struct data to this struct.

Parameters
src:AIFace

the source struct

Returns:AIFace

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

extends StructBuffer<AIFace, AIFace.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of AIFace structs.

Field Summary

Modifier and TypeField and Description
private static final AIFace
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

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

public IntBuffer

Returns:

a IntBuffer view of the data pointed to by the AIFace#mIndices field.
mIndices()

public AIFace.Buffer
mIndices(IntBuffer value)

Sets the address of the specified IntBuffer to the AIFace#mIndices field.

public int

Returns:

the value of the AIFace#mNumIndices field.
mNumIndices()

protected AIFace.Buffer
self()

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

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final AIFace ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
mIndicesback to summary
public IntBuffer mIndices()
Returns:IntBuffer

a IntBuffer view of the data pointed to by the AIFace#mIndices field.

Annotations
@NativeType:unsigned int *
mIndicesback to summary
public AIFace.Buffer mIndices(IntBuffer value)

Sets the address of the specified IntBuffer to the AIFace#mIndices field.

mNumIndicesback to summary
public int mNumIndices()
Returns:int

the value of the AIFace#mNumIndices field.

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

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

Annotations
@Override