diff --git a/include/assimp/material.h b/include/assimp/material.h index 30db265e8..484a5192a 100644 --- a/include/assimp/material.h +++ b/include/assimp/material.h @@ -334,7 +334,12 @@ enum aiTextureType { #define AI_TEXTURE_TYPE_MAX aiTextureType_TRANSMISSION // ------------------------------------------------------------------------------- -// Get a string for a given aiTextureType +/** + * @brief Get a string for a given aiTextureType + * + * @param in The texture type + * @return The description string for the texture type. + */ ASSIMP_API const char *aiTextureTypeToString(enum aiTextureType in); // --------------------------------------------------------------------------- @@ -425,7 +430,8 @@ enum aiShadingMode { }; // --------------------------------------------------------------------------- -/** @brief Defines some mixed flags for a particular texture. +/** + * @brief Defines some mixed flags for a particular texture. * * Usually you'll instruct your cg artists how textures have to look like ... * and how they will be processed in your application. However, if you use @@ -464,7 +470,8 @@ enum aiTextureFlags { }; // --------------------------------------------------------------------------- -/** @brief Defines alpha-blend flags. +/** + * @brief Defines alpha-blend flags. * * If you're familiar with OpenGL or D3D, these flags aren't new to you. * They define *how* the final color value of a pixel is computed, basing @@ -508,7 +515,8 @@ enum aiBlendMode { #include "./Compiler/pushpack1.h" // --------------------------------------------------------------------------- -/** @brief Defines how an UV channel is transformed. +/** + * @brief Defines how an UV channel is transformed. * * This is just a helper structure for the #AI_MATKEY_UVTRANSFORM key. * See its documentation for more details. @@ -552,8 +560,8 @@ struct aiUVTransform { //! @cond AI_DOX_INCLUDE_INTERNAL // --------------------------------------------------------------------------- -/** @brief A very primitive RTTI system for the contents of material - * properties. +/** + * @brief A very primitive RTTI system for the contents of material properties. */ enum aiPropertyTypeInfo { /** Array of single-precision (32 Bit) floats @@ -698,7 +706,14 @@ struct aiMaterial #ifdef __cplusplus public: + /** + * @brief The class constructor. + */ aiMaterial(); + + /** + * @brief The class destructor. + */ ~aiMaterial(); // ------------------------------------------------------------------- @@ -1016,7 +1031,7 @@ extern "C" { // Clearcoat // --------- // Clearcoat layer intensity. 0.0 = none (disabled) -#define AI_MATKEY_CLEARCOAT_FACTOR "$mat.clearcoat.factor", 0, 0 +#define AI_MATKEY_CLEARCOAT_FACTOR "$mat.clearcoat.factor", 0, 0 #define AI_MATKEY_CLEARCOAT_ROUGHNESS_FACTOR "$mat.clearcoat.roughnessFactor", 0, 0 #define AI_MATKEY_CLEARCOAT_TEXTURE aiTextureType_CLEARCOAT, 0 #define AI_MATKEY_CLEARCOAT_ROUGHNESS_TEXTURE aiTextureType_CLEARCOAT, 1 @@ -1046,23 +1061,23 @@ extern "C" { // Emissive // -------- -#define AI_MATKEY_USE_EMISSIVE_MAP "$mat.useEmissiveMap", 0, 0 +#define AI_MATKEY_USE_EMISSIVE_MAP "$mat.useEmissiveMap", 0, 0 #define AI_MATKEY_EMISSIVE_INTENSITY "$mat.emissiveIntensity", 0, 0 -#define AI_MATKEY_USE_AO_MAP "$mat.useAOMap", 0, 0 +#define AI_MATKEY_USE_AO_MAP "$mat.useAOMap", 0, 0 // --------------------------------------------------------------------------- // Pure key names for all texture-related properties //! @cond MATS_DOC_FULL -#define _AI_MATKEY_TEXTURE_BASE "$tex.file" -#define _AI_MATKEY_UVWSRC_BASE "$tex.uvwsrc" -#define _AI_MATKEY_TEXOP_BASE "$tex.op" -#define _AI_MATKEY_MAPPING_BASE "$tex.mapping" -#define _AI_MATKEY_TEXBLEND_BASE "$tex.blend" +#define _AI_MATKEY_TEXTURE_BASE "$tex.file" +#define _AI_MATKEY_UVWSRC_BASE "$tex.uvwsrc" +#define _AI_MATKEY_TEXOP_BASE "$tex.op" +#define _AI_MATKEY_MAPPING_BASE "$tex.mapping" +#define _AI_MATKEY_TEXBLEND_BASE "$tex.blend" #define _AI_MATKEY_MAPPINGMODE_U_BASE "$tex.mapmodeu" #define _AI_MATKEY_MAPPINGMODE_V_BASE "$tex.mapmodev" -#define _AI_MATKEY_TEXMAP_AXIS_BASE "$tex.mapaxis" -#define _AI_MATKEY_UVTRANSFORM_BASE "$tex.uvtrafo" -#define _AI_MATKEY_TEXFLAGS_BASE "$tex.flags" +#define _AI_MATKEY_TEXMAP_AXIS_BASE "$tex.mapaxis" +#define _AI_MATKEY_UVTRANSFORM_BASE "$tex.uvtrafo" +#define _AI_MATKEY_TEXFLAGS_BASE "$tex.flags" //! @endcond // ---------------------------------------------------------------------------