AIMaterialProperty (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.assimp.AIMaterialProperty

All Implemented Interfaces:

org.lwjgl.system.Pointer
```
public class AIMaterialProperty
extends org.lwjgl.system.Struct
```
Data structure for a single material property.
As a user, you'll probably never need to deal with this data structure. Just use the provided aiGetMaterialXXX() family of functions to query material properties easily. Processing them manually is faster, but it is not the recommended way. It isn't worth the effort.

Material property names follow a simple scheme:
```
 $<name>
 ?<name>
     A public property, there must be corresponding AI_MATKEY_XXX define
     2nd: Public, but ignored by the aiProcess_RemoveRedundantMaterials
     post-processing step.
 ~<name>
     A temporary property for internal use.
```
Member documentation
- mKey – Specifies the name of the property (key). Keys are generally case insensitive.
- mSemantic – Textures: Specifies their exact usage semantic. For non-texture properties, this member is always 0 (or, better-said, TextureType_NONE).
- mIndex – Textures: Specifies the index of the texture. For non-texture properties, this member is always 0.
- mDataLength – Size of the buffer mData is pointing to, in bytes. This value may not be 0.
- mType – Type information for the property. Defines the data layout inside the data buffer. This is used by the library internally to perform debug checks and to utilize proper type conversions. (It's probably a hacky solution, but it works.)
- mData – Binary buffer to hold the property's value. The size of the buffer is always mDataLength.
Layout
```
 struct aiMaterialProperty {
     struct aiString mKey;
     unsigned int mSemantic;
     unsigned int mIndex;
     unsigned int mDataLength;
     aiPropertyTypeInfo mType;
     char * mData;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AIMaterialProperty.Buffer
An array of AIMaterialProperty structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`AIMaterialProperty.Buffer` An array of `AIMaterialProperty` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`MDATA` The struct member offsets.
`static int`	`MDATALENGTH` The struct member offsets.
`static int`	`MINDEX` The struct member offsets.
`static int`	`MKEY` The struct member offsets.
`static int`	`MSEMANTIC` The struct member offsets.
`static int`	`MTYPE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`AIMaterialProperty(java.nio.ByteBuffer container)` Creates a `AIMaterialProperty` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AIMaterialProperty`	`create(long address)` Returns a new `AIMaterialProperty` instance for the specified memory address.
`static AIMaterialProperty.Buffer`	`create(long address, int capacity)` Create a `AIMaterialProperty.Buffer` instance at the specified memory.
`static AIMaterialProperty`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static AIMaterialProperty.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`java.nio.ByteBuffer`	`mData()` Returns a `ByteBuffer` view of the data pointed to by the `mData` field.
`int`	`mDataLength()` Returns the value of the `mDataLength` field.
`int`	`mIndex()` Returns the value of the `mIndex` field.
`AIString`	`mKey()` Returns a `AIString` view of the `mKey` field.
`int`	`mSemantic()` Returns the value of the `mSemantic` field.
`int`	`mType()` Returns the value of the `mType` field.
`static java.nio.ByteBuffer`	`nmData(long struct)` Unsafe version of `mData`.
`static int`	`nmDataLength(long struct)` Unsafe version of `mDataLength()`.
`static int`	`nmIndex(long struct)` Unsafe version of `mIndex()`.
`static AIString`	`nmKey(long struct)` Unsafe version of `mKey()`.
`static int`	`nmSemantic(long struct)` Unsafe version of `mSemantic()`.
`static int`	`nmType(long struct)` Unsafe version of `mType()`.
`int`	`sizeof()`

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - MKEY
```
public static final int MKEY
```
    The struct member offsets.
  - MSEMANTIC
```
public static final int MSEMANTIC
```
    The struct member offsets.
  - MINDEX
```
public static final int MINDEX
```
    The struct member offsets.
  - MDATALENGTH
```
public static final int MDATALENGTH
```
    The struct member offsets.
  - MTYPE
```
public static final int MTYPE
```
    The struct member offsets.
  - MDATA
```
public static final int MDATA
```
    The struct member offsets.
- Constructor Detail
  - AIMaterialProperty
```
public AIMaterialProperty(java.nio.ByteBuffer container)
```
    Creates a AIMaterialProperty 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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - mKey
```
public AIString mKey()
```
    Returns a AIString view of the mKey field.
  - mSemantic
```
public int mSemantic()
```
    Returns the value of the mSemantic field.
  - mIndex
```
public int mIndex()
```
    Returns the value of the mIndex field.
  - mDataLength
```
public int mDataLength()
```
    Returns the value of the mDataLength field.
  - mType
```
public int mType()
```
    Returns the value of the mType field.
  - mData
```
public java.nio.ByteBuffer mData()
```
    Returns a ByteBuffer view of the data pointed to by the mData field.
  - create
```
public static AIMaterialProperty create(long address)
```
    Returns a new AIMaterialProperty instance for the specified memory address.
  - createSafe
```
@Nullable
public static AIMaterialProperty createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - create
```
public static AIMaterialProperty.Buffer create(long address,
                                               int capacity)
```
    Create a AIMaterialProperty.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static AIMaterialProperty.Buffer createSafe(long address,
                                                             int capacity)
```
    Like create, but returns null if address is NULL.
  - nmKey
```
public static AIString nmKey(long struct)
```
    Unsafe version of mKey().
  - nmSemantic
```
public static int nmSemantic(long struct)
```
    Unsafe version of mSemantic().
  - nmIndex
```
public static int nmIndex(long struct)
```
    Unsafe version of mIndex().
  - nmDataLength
```
public static int nmDataLength(long struct)
```
    Unsafe version of mDataLength().
  - nmType
```
public static int nmType(long struct)
```
    Unsafe version of mType().
  - nmData
```
public static java.nio.ByteBuffer nmData(long struct)
```
    Unsafe version of mData.

Class AIMaterialProperty

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Field Detail

SIZEOF

ALIGNOF

MKEY

MSEMANTIC

MINDEX

MDATALENGTH

MTYPE

MDATA

Constructor Detail

AIMaterialProperty

Method Detail

sizeof

mKey

mSemantic

mIndex

mDataLength

mType

mData

create

createSafe

create

createSafe

nmKey

nmSemantic

nmIndex

nmDataLength

nmType

nmData