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

- Importer::ReadFileFromMemory/aiImportFileFromMemory() clarify wording in documentation

pull/20/head
Alexander Gessler 2013-03-10 19:15:14 +01:00
parent e1cdb57eca
commit 260568912c
2 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
include/assimp/Importer.hpp
View File

@ -409,11 +409,12 @@ public:
* instance. Use GetOrphanedScene() to take ownership of it. * instance. Use GetOrphanedScene() to take ownership of it.
* *
* @note This is a straightforward way to decode models from memory * @note This is a straightforward way to decode models from memory
* buffers, but it doesn't handle model formats spreading their * buffers, but it doesn't handle model formats that spread their
* data across multiple files or even directories. Examples include * data across multiple files or even directories. Examples include
* OBJ or MD3, which outsource parts of their material stuff into * OBJ or MD3, which outsource parts of their material info into
* external scripts. If you need the full functionality, provide * external scripts. If you need full functionality, provide
* a custom IOSystem to make Assimp find these files. * a custom IOSystem to make Assimp find these files and use
* the regular ReadFile() API.
*/ */
const aiScene* ReadFileFromMemory( const aiScene* ReadFileFromMemory(
const void* pBuffer, const void* pBuffer,

12
include/assimp/cimport.h
View File

@ -170,11 +170,13 @@ ASSIMP_API const C_STRUCT aiScene* aiImportFileExWithProperties(
* Check the return value, and you'll know ... * Check the return value, and you'll know ...
* @return A pointer to the imported data, NULL if the import failed. * @return A pointer to the imported data, NULL if the import failed.
* *
* @note This is a straightforward way to decode models from memory buffers, but it * @note This is a straightforward way to decode models from memory
* doesn't handle model formats spreading their data across multiple files or even * buffers, but it doesn't handle model formats that spread their
* directories. Examples include OBJ or MD3, which outsource parts of their material * data across multiple files or even directories. Examples include
* stuff into external scripts. If you need the full functionality, provide a custom * OBJ or MD3, which outsource parts of their material info into
* IOSystem to make Assimp find these files. * external scripts. If you need full functionality, provide
* a custom IOSystem to make Assimp find these files and use
* the regular aiImportFileEx()/aiImportFileExWithProperties() API.
*/ */
ASSIMP_API const C_STRUCT aiScene* aiImportFileFromMemory( ASSIMP_API const C_STRUCT aiScene* aiImportFileFromMemory(
const char* pBuffer, const char* pBuffer,