From fd0b3490d1d8a53249f3a8cf19e8fde809e17df8 Mon Sep 17 00:00:00 2001 From: Alexander Gessler Date: Mon, 2 Sep 2013 21:33:43 +0200 Subject: [PATCH] Clarify exporter doc: how to get a modifiable copy of a previously imported scene. --- include/assimp/Exporter.hpp | 8 ++++++-- include/assimp/cexport.h | 4 ++++ 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/include/assimp/Exporter.hpp b/include/assimp/Exporter.hpp index 30db01508..407fae4e3 100644 --- a/include/assimp/Exporter.hpp +++ b/include/assimp/Exporter.hpp @@ -167,7 +167,9 @@ public: * @return the exported data or NULL in case of error. * @note If the Exporter instance did already hold a blob from * a previous call to #ExportToBlob, it will be disposed. - * Any IO handlers set via #SetIOHandler are ignored here.*/ + * Any IO handlers set via #SetIOHandler are ignored here. + * @note Use aiCopyScene() to get a modifiable copy of a previously + * imported scene. */ const aiExportDataBlob* ExportToBlob( const aiScene* pScene, const char* pFormatId, unsigned int pPreprocessing = 0u ); inline const aiExportDataBlob* ExportToBlob( const aiScene* pScene, const std::string& pFormatId, unsigned int pPreprocessing = 0u ); @@ -196,7 +198,9 @@ public: * is triangulation - whilst you can enforce it by specifying * the #aiProcess_Triangulate flag, most export formats support only * triangulate data so they would run the step even if it wasn't requested. - * @return AI_SUCCESS if everything was fine. */ + * @return AI_SUCCESS if everything was fine. + * @note Use aiCopyScene() to get a modifiable copy of a previously + * imported scene.*/ aiReturn Export( const aiScene* pScene, const char* pFormatId, const char* pPath, unsigned int pPreprocessing = 0u); inline aiReturn Export( const aiScene* pScene, const std::string& pFormatId, const std::string& pPath, unsigned int pPreprocessing = 0u); diff --git a/include/assimp/cexport.h b/include/assimp/cexport.h index 14b9be189..797d5db1a 100644 --- a/include/assimp/cexport.h +++ b/include/assimp/cexport.h @@ -144,6 +144,8 @@ ASSIMP_API void aiFreeScene(const C_STRUCT aiScene* pIn); * the #aiProcess_Triangulate flag, most export formats support only * triangulate data so they would run the step anyway. * @return a status code indicating the result of the export +* @note Use aiCopyScene() to get a modifiable copy of a previously +* imported scene. */ ASSIMP_API aiReturn aiExportScene( const C_STRUCT aiScene* pScene, const char* pFormatId, @@ -163,6 +165,8 @@ ASSIMP_API aiReturn aiExportScene( const C_STRUCT aiScene* pScene, * @param pPreprocessing Please see the documentation for #aiExportScene * @return a status code indicating the result of the export * @note Include for the definition of #aiFileIO. +* @note Use aiCopyScene() to get a modifiable copy of a previously +* imported scene. */ ASSIMP_API aiReturn aiExportSceneEx( const C_STRUCT aiScene* pScene, const char* pFormatId,