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

Optimize readability (#5578)

pull/5577/head^2
Kim Kulling 2024-05-18 22:06:04 +02:00 committed by GitHub
parent 787c9afdf7
commit fd3f092d6e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 32 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
include/assimp/material.h
View File

@ -334,7 +334,12 @@ enum aiTextureType {
#define AI_TEXTURE_TYPE_MAX aiTextureType_TRANSMISSION #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); 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 ... * 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 * 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. * 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 * They define *how* the final color value of a pixel is computed, basing
@ -508,7 +515,8 @@ enum aiBlendMode {
#include "./Compiler/pushpack1.h" #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. * This is just a helper structure for the #AI_MATKEY_UVTRANSFORM key.
* See its documentation for more details. * See its documentation for more details.
@ -552,8 +560,8 @@ struct aiUVTransform {
//! @cond AI_DOX_INCLUDE_INTERNAL //! @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 { enum aiPropertyTypeInfo {
/** Array of single-precision (32 Bit) floats /** Array of single-precision (32 Bit) floats
@ -698,7 +706,14 @@ struct aiMaterial
#ifdef __cplusplus #ifdef __cplusplus
public: public:
/**
* @brief The class constructor.
*/
aiMaterial(); aiMaterial();
/**
* @brief The class destructor.
*/
~aiMaterial(); ~aiMaterial();
// ------------------------------------------------------------------- // -------------------------------------------------------------------