Top Description Inners Fields Constructors Methods
org.lwjgl.assimp

public Class AIMaterial

extends Struct<AIMaterial>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct aiMaterial
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Data structure for a material.

Material data is stored using a key-value structure. A single key-value pair is called a 'material property'. C++ users should use the provided member functions of aiMaterial to process material properties, C users have to stick with the aiMaterialGetXXX family of unbound functions. The library defines a set of standard keys (AI_MATKEY_XXX).

Layout


struct aiMaterial {
    struct aiMaterialProperty ** mProperties;
    unsigned int mNumProperties;
    unsigned int mNumAllocated;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
AIMaterial.Buffer

An array of AIMaterial structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MNUMALLOCATED

The struct member offsets.

public static final int
MNUMPROPERTIES

The struct member offsets.

public static final int
MPROPERTIES

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

public
AIMaterial(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static AIMaterial
calloc()

Returns a new AIMaterial instance allocated with memCalloc.

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

Returns a new AIMaterial.Buffer instance allocated with memCalloc.

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

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

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

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

public static AIMaterial
callocStack()

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

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

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

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

Returns a new AIMaterial instance allocated with BufferUtils.

public static AIMaterial
create(long address)

Returns a new AIMaterial instance for the specified memory address.

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

Returns a new AIMaterial.Buffer instance allocated with BufferUtils.

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

Create a AIMaterial.Buffer instance at the specified memory.

public static AIMaterial
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static AIMaterial
malloc()

Returns a new AIMaterial instance allocated with memAlloc.

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

Returns a new AIMaterial.Buffer instance allocated with memAlloc.

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

Returns a new AIMaterial instance allocated on the specified MemoryStack.

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

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

public static AIMaterial
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public int
mNumAllocated()

Storage allocated

public AIMaterial
mNumAllocated(int value)

Sets the specified value to the mNumAllocated field.

public int
mNumProperties()

Number of properties in the data base

public PointerBuffer
mProperties()

List of all material properties loaded.

public AIMaterial
mProperties(PointerBuffer value)

Sets the address of the specified PointerBuffer to the mProperties field.

public static int
nmNumAllocated(long struct)

Unsafe version of mNumAllocated.

public static void
nmNumAllocated(long struct, int value)

Unsafe version of mNumAllocated.

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 PointerBuffer
nmProperties(long struct)

Unsafe version of mProperties.

public static void
nmProperties(long struct, PointerBuffer value)

Unsafe version of mProperties.

public AIMaterial
set(PointerBuffer mProperties, int mNumAllocated)

Initializes this struct with the specified values.

public AIMaterial

Returns:

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

MNUMALLOCATEDback to summary
public static final int MNUMALLOCATED

The struct member offsets.

MNUMPROPERTIESback to summary
public static final int MNUMPROPERTIES

The struct member offsets.

MPROPERTIESback to summary
public static final int MPROPERTIES

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

AIMaterialback to summary
protected AIMaterial(long address, ByteBuffer container)
AIMaterialback to summary
public AIMaterial(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static AIMaterial calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new AIMaterial instance allocated with BufferUtils.

createback to summary
public static AIMaterial create(long address)

Returns a new AIMaterial instance for the specified memory address.

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

Returns a new AIMaterial.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a AIMaterial.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static AIMaterial createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static AIMaterial malloc(MemoryStack stack)

Returns a new AIMaterial instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mNumAllocatedback to summary
public int mNumAllocated()

Storage allocated

Annotations
@NativeType:unsigned int
mNumAllocatedback to summary
public AIMaterial mNumAllocated(int value)

Sets the specified value to the mNumAllocated field.

mNumPropertiesback to summary
public int mNumProperties()

Number of properties in the data base

Annotations
@NativeType:unsigned int
mPropertiesback to summary
public PointerBuffer mProperties()

List of all material properties loaded.

Annotations
@NativeType:struct aiMaterialProperty **
mPropertiesback to summary
public AIMaterial mProperties(PointerBuffer value)

Sets the address of the specified PointerBuffer to the mProperties field.

nmNumAllocatedback to summary
public static int nmNumAllocated(long struct)

Unsafe version of mNumAllocated.

nmNumAllocatedback to summary
public static void nmNumAllocated(long struct, int value)

Unsafe version of mNumAllocated.

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.

nmPropertiesback to summary
public static PointerBuffer nmProperties(long struct)

Unsafe version of mProperties.

nmPropertiesback to summary
public static void nmProperties(long struct, PointerBuffer value)

Unsafe version of mProperties.

setback to summary
public AIMaterial set(PointerBuffer mProperties, int mNumAllocated)

Initializes this struct with the specified values.

setback to summary
public AIMaterial set(AIMaterial src)

Copies the specified struct data to this struct.

Parameters
src:AIMaterial

the source struct

Returns:AIMaterial

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

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

Field Summary

Modifier and TypeField and Description
private static final AIMaterial
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

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

public int

Returns:

the value of the AIMaterial#mNumAllocated field.
mNumAllocated()

public AIMaterial.Buffer
mNumAllocated(int value)

Sets the specified value to the AIMaterial#mNumAllocated field.

public int

Returns:

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

public PointerBuffer

Returns:

a PointerBuffer view of the data pointed to by the AIMaterial#mProperties field.
mProperties()

public AIMaterial.Buffer
mProperties(PointerBuffer value)

Sets the address of the specified PointerBuffer to the AIMaterial#mProperties field.

protected AIMaterial.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 AIMaterial ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
mNumAllocatedback to summary
public int mNumAllocated()
Returns:int

the value of the AIMaterial#mNumAllocated field.

Annotations
@NativeType:unsigned int
mNumAllocatedback to summary
public AIMaterial.Buffer mNumAllocated(int value)

Sets the specified value to the AIMaterial#mNumAllocated field.

mNumPropertiesback to summary
public int mNumProperties()
Returns:int

the value of the AIMaterial#mNumProperties field.

Annotations
@NativeType:unsigned int
mPropertiesback to summary
public PointerBuffer mProperties()
Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the AIMaterial#mProperties field.

Annotations
@NativeType:struct aiMaterialProperty **
mPropertiesback to summary
public AIMaterial.Buffer mProperties(PointerBuffer value)

Sets the address of the specified PointerBuffer to the AIMaterial#mProperties field.

selfback to summary
protected AIMaterial.Buffer self()

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

Annotations
@Override