Merge pull request #1279 from Squareys/update-docs

Update docs (Logging, Preamble Copyright and embedded Textures)
pull/1110/merge
Kim Kulling 2017-05-20 20:45:26 +02:00 committed by GitHub
commit b84de79219
2 changed files with 20 additions and 31 deletions

View File

@ -3,7 +3,7 @@
Open Asset Import Library (assimp) Open Asset Import Library (assimp)
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
Copyright (c) 2006-2012, assimp team Copyright (c) 2006-2017, assimp team
All rights reserved. All rights reserved.

View File

@ -472,22 +472,9 @@ Just derivate your own logger from the abstract base class LogStream and overwri
@code @code
// Example stream // Example stream
class myStream : class myStream : public LogStream
public LogStream
{ {
public: public:
// Constructor
myStream()
{
// empty
}
// Destructor
~myStream()
{
// empty
}
// Write womethink using your own functionality // Write womethink using your own functionality
void write(const char* message) void write(const char* message)
{ {
@ -496,10 +483,10 @@ public:
}; };
// Select the kinds of messages you want to receive on this log stream // Select the kinds of messages you want to receive on this log stream
const unsigned int severity = Logger::DEBUGGING|Logger::INFO|Logger::ERR|Logger::WARN; const unsigned int severity = Logger::Debugging|Logger::Info|Logger::Err|Logger::Warn;
// Attaching it to the default logger // Attaching it to the default logger
Assimp::DefaultLogger::get()->attachStream( new myStream(), severity ); Assimp::DefaultLogger::get()->attachStream( new myStream, severity );
@endcode @endcode
@ -512,10 +499,10 @@ flag set:
@code @code
unsigned int severity = 0; unsigned int severity = 0;
severity |= Logger::DEBUGGING; severity |= Logger::Debugging;
// Detach debug messages from you self defined stream // Detach debug messages from you self defined stream
Assimp::DefaultLogger::get()->attachStream( new myStream(), severity ); Assimp::DefaultLogger::get()->attachStream( new myStream, severity );
@endcode @endcode
@ -743,6 +730,8 @@ need them at all.
Normally textures used by assets are stored in separate files, however, Normally textures used by assets are stored in separate files, however,
there are file formats embedding their textures directly into the model file. there are file formats embedding their textures directly into the model file.
Such textures are loaded into an aiTexture structure. Such textures are loaded into an aiTexture structure.
For embedded textures, the value of `AI_MATKEY_TEXTURE(textureType, index)` will be `*<index>` where
`<index>` is the index of the texture in aiScene::mTextures.
<br> <br>
There are two cases: There are two cases:
<br> <br>
@ -930,7 +919,7 @@ All material key constants start with 'AI_MATKEY' (it's an ugly macro for histor
<td><tt>TEXTURE(t,n)</tt></td> <td><tt>TEXTURE(t,n)</tt></td>
<td>aiString</td> <td>aiString</td>
<td>n/a</td> <td>n/a</td>
<td>Defines the path to the n'th texture on the stack 't', where 'n' is any value >= 0 and 't' is one of the #aiTextureType enumerated values.</td> <td>Defines the path of the n'th texture on the stack 't', where 'n' is any value >= 0 and 't' is one of the #aiTextureType enumerated values. Either a filepath or `*<index>`, where `<index>` is the index of an embedded texture in aiScene::mTextures.</td>
<td>See the 'Textures' section above.</td> <td>See the 'Textures' section above.</td>
</tr> </tr>