Merge pull request #1279 from Squareys/update-docs
Update docs (Logging, Preamble Copyright and embedded Textures)pull/1110/merge
commit
b84de79219
|
@ -3,7 +3,7 @@
|
|||
Open Asset Import Library (assimp)
|
||||
---------------------------------------------------------------------------
|
||||
|
||||
Copyright (c) 2006-2012, assimp team
|
||||
Copyright (c) 2006-2017, assimp team
|
||||
|
||||
All rights reserved.
|
||||
|
||||
|
|
27
doc/dox.h
27
doc/dox.h
|
@ -472,22 +472,9 @@ Just derivate your own logger from the abstract base class LogStream and overwri
|
|||
|
||||
@code
|
||||
// Example stream
|
||||
class myStream :
|
||||
public LogStream
|
||||
class myStream : public LogStream
|
||||
{
|
||||
public:
|
||||
// Constructor
|
||||
myStream()
|
||||
{
|
||||
// empty
|
||||
}
|
||||
|
||||
// Destructor
|
||||
~myStream()
|
||||
{
|
||||
// empty
|
||||
}
|
||||
|
||||
// Write womethink using your own functionality
|
||||
void write(const char* message)
|
||||
{
|
||||
|
@ -496,10 +483,10 @@ public:
|
|||
};
|
||||
|
||||
// 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
|
||||
Assimp::DefaultLogger::get()->attachStream( new myStream(), severity );
|
||||
Assimp::DefaultLogger::get()->attachStream( new myStream, severity );
|
||||
|
||||
@endcode
|
||||
|
||||
|
@ -512,10 +499,10 @@ flag set:
|
|||
@code
|
||||
|
||||
unsigned int severity = 0;
|
||||
severity |= Logger::DEBUGGING;
|
||||
severity |= Logger::Debugging;
|
||||
|
||||
// Detach debug messages from you self defined stream
|
||||
Assimp::DefaultLogger::get()->attachStream( new myStream(), severity );
|
||||
Assimp::DefaultLogger::get()->attachStream( new myStream, severity );
|
||||
|
||||
@endcode
|
||||
|
||||
|
@ -743,6 +730,8 @@ need them at all.
|
|||
Normally textures used by assets are stored in separate files, however,
|
||||
there are file formats embedding their textures directly into the model file.
|
||||
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>
|
||||
There are two cases:
|
||||
<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>aiString</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>
|
||||
</tr>
|
||||
|
||||
|
|
Loading…
Reference in New Issue