Assimp  v3.1.1 (June 2014)
assimp::material::aiMaterialProperty Struct Reference

Data structure for a single material property. More...

Public Attributes

char * mData
 Binary buffer to hold the property's value. More...
 
uint mDataLength
 Size of the buffer mData is pointing to (in bytes). More...
 
uint mIndex
 For texture properties, this specifies the index of the texture. More...
 
aiString mKey
 Specifies the name of the property (key). More...
 
uint mSemantic
 For texture properties, this specifies the exact usage semantic. More...
 
aiPropertyTypeInfo mType
 Type information for the property. More...
 

Detailed Description

Data structure for a single material property.

As an user, you'll probably never need to deal with this data structure. Just use the provided aiGetMaterialXXX() 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]: A public property, there must be a corresponding AI_MATKEY_XXX constant.

?[name]: Also public, but ignored by the aiProcess.RemoveRedundantMaterials post-processing step.

~[name]: A temporary property for internal use.

Member Data Documentation

char* assimp::material::aiMaterialProperty::mData

Binary buffer to hold the property's value.

The size of the buffer is always mDataLength.

uint assimp::material::aiMaterialProperty::mDataLength

Size of the buffer mData is pointing to (in bytes).

This value may not be 0.

uint assimp::material::aiMaterialProperty::mIndex

For texture properties, this specifies the index of the texture.

For non-texture properties, this member is always 0.

aiString assimp::material::aiMaterialProperty::mKey

Specifies the name of the property (key).

Keys are generally case insensitive.

uint assimp::material::aiMaterialProperty::mSemantic

For texture properties, this specifies the exact usage semantic.

For non-texture properties, this member is always 0 (or rather aiTextureType.NONE).

aiPropertyTypeInfo assimp::material::aiMaterialProperty::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.


The documentation for this struct was generated from the following file: