v4games
/
assimp
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #970 from nyorain/patch-1 

Added documentation for embedded textures
pull/974/head
Alexander Gessler 2016-08-09 01:43:19 +02:00 committed by GitHub
parent 86f30e4852 e7ed352078
commit fefa4ee9c1
1 changed files with 31 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
include/assimp/material.h
View File

@ -714,30 +714,33 @@ public:
// ------------------------------------------------------------------- // -------------------------------------------------------------------
/** Helper function to get all parameters pertaining to a /** Helper function to get all parameters pertaining to a
* particular texture slot from a material. * particular texture slot from a material.
* *
* This function is provided just for convenience, you could also * This function is provided just for convenience, you could also
* read the single material properties manually. * read the single material properties manually.
* @param type Specifies the type of the texture to be retrieved ( * @param type Specifies the type of the texture to be retrieved (
* e.g. diffuse, specular, height map ...) * e.g. diffuse, specular, height map ...)
* @param index Index of the texture to be retrieved. The function fails * @param index Index of the texture to be retrieved. The function fails
* if there is no texture of that type with this index. * if there is no texture of that type with this index.
* #GetTextureCount() can be used to determine the number of textures * #GetTextureCount() can be used to determine the number of textures
* per texture type. * per texture type.
* @param path Receives the path to the texture. * @param path Receives the path to the texture.
* NULL is a valid value. * If the texture is embedded, receives a '*' followed by the id of
* @param mapping The texture mapping. * the texture (for the textures stored in the corresponding scene) which
* NULL is allowed as value. * can be converted to an int using a function like atoi.
* @param uvindex Receives the UV index of the texture. * NULL is a valid value.
* NULL is a valid value. * @param mapping The texture mapping.
* @param blend Receives the blend factor for the texture * NULL is allowed as value.
* NULL is a valid value. * @param uvindex Receives the UV index of the texture.
* @param op Receives the texture operation to be performed between * NULL is a valid value.
* this texture and the previous texture. NULL is allowed as value. * @param blend Receives the blend factor for the texture
* @param mapmode Receives the mapping modes to be used for the texture. * NULL is a valid value.
* The parameter may be NULL but if it is a valid pointer it MUST * @param op Receives the texture operation to be performed between
* point to an array of 3 aiTextureMapMode's (one for each * this texture and the previous texture. NULL is allowed as value.
* axis: UVW order (=XYZ)). * @param mapmode Receives the mapping modes to be used for the texture.
*/ * The parameter may be NULL but if it is a valid pointer it MUST
* point to an array of 3 aiTextureMapMode's (one for each
* axis: UVW order (=XYZ)).
*/
// ------------------------------------------------------------------- // -------------------------------------------------------------------
aiReturn GetTexture(aiTextureType type, aiReturn GetTexture(aiTextureType type,
unsigned int index, unsigned int index,
@ -1506,7 +1509,10 @@ ASSIMP_API unsigned int aiGetMaterialTextureCount(const C_STRUCT aiMaterial* pMa
* #aiGetMaterialTextureCount() can be used to determine the number of * #aiGetMaterialTextureCount() can be used to determine the number of
* textures in a particular texture stack. * textures in a particular texture stack.
* @param[out] path Receives the output path * @param[out] path Receives the output path
* This parameter must be non-null. * If the texture is embedded, receives a '*' followed by the id of
* the texture (for the textures stored in the corresponding scene) which
* can be converted to an int using a function like atoi.
* This parameter must be non-null.
* @param mapping The texture mapping mode to be used. * @param mapping The texture mapping mode to be used.
* Pass NULL if you're not interested in this information. * Pass NULL if you're not interested in this information.
* @param[out] uvindex For UV-mapped textures: receives the index of the UV * @param[out] uvindex For UV-mapped textures: receives the index of the UV