Minor doc improvements
This commit is contained in:
parent
ffcb0a5189
commit
5214718a2b
@ -6,7 +6,7 @@
|
|||||||
file formats(eg. <a href="https://en.wikipedia.org/wiki/STL_%28file_format%29">STL</a>)
|
file formats(eg. <a href="https://en.wikipedia.org/wiki/STL_%28file_format%29">STL</a>)
|
||||||
|
|
||||||
gmio aims to be <a href="https://github.com/fougue/gmio/wiki/4.-Benchmarks">fast</a>,
|
gmio aims to be <a href="https://github.com/fougue/gmio/wiki/4.-Benchmarks">fast</a>,
|
||||||
portable(C90 conformance) and feature-rich.
|
portable(C99 conformance) and feature-rich.
|
||||||
Main highlights:
|
Main highlights:
|
||||||
|
|
||||||
\li <i>Abstract</i> streams that does not tie the user to C stream(\c FILE*)
|
\li <i>Abstract</i> streams that does not tie the user to C stream(\c FILE*)
|
||||||
@ -14,7 +14,16 @@
|
|||||||
\li Operations can be easily aborted
|
\li Operations can be easily aborted
|
||||||
\li Progress report about the I/O operation
|
\li Progress report about the I/O operation
|
||||||
|
|
||||||
Current version only supports the STereoLithography format(STL), see module \ref gmio_stl
|
|
||||||
|
Supported formats | Read | Write
|
||||||
|
--------------------------|--------|---------
|
||||||
|
STL ascii | yes | yes
|
||||||
|
STL binary(little-endian) | yes | yes
|
||||||
|
STL binary(big-endian) | yes | yes
|
||||||
|
AMF uncompressed | no | yes
|
||||||
|
AMF zip | no | yes
|
||||||
|
AMF zip64 | no | yes
|
||||||
|
|
||||||
|
|
||||||
\section build Building gmio
|
\section build Building gmio
|
||||||
|
|
||||||
|
@ -51,10 +51,8 @@ struct gmio_stl_mesh_creator_infos
|
|||||||
/*! Format of the input STL mesh */
|
/*! Format of the input STL mesh */
|
||||||
enum gmio_stl_format format;
|
enum gmio_stl_format format;
|
||||||
|
|
||||||
/*! Null terminated C-string holding the STL mesh(solid) name
|
/*! Null terminated C-string holding the STL mesh(solid) name.
|
||||||
*
|
* Available only if STL ASCII format, \c NULL otherwise */
|
||||||
* Available only if STL ASCII format, \c NULL otherwise
|
|
||||||
*/
|
|
||||||
const char* stla_solid_name;
|
const char* stla_solid_name;
|
||||||
|
|
||||||
/*! Total size (in bytes) of the input stream
|
/*! Total size (in bytes) of the input stream
|
||||||
@ -66,16 +64,12 @@ struct gmio_stl_mesh_creator_infos
|
|||||||
*/
|
*/
|
||||||
gmio_streamsize_t stla_stream_size;
|
gmio_streamsize_t stla_stream_size;
|
||||||
|
|
||||||
/*! Contains the header data(80 bytes)
|
/*! Contains the header data(80 bytes).
|
||||||
*
|
* Available only if binary STL, \c NULL otherwise */
|
||||||
* Available only if binary STL, \c NULL otherwise
|
|
||||||
*/
|
|
||||||
const struct gmio_stlb_header* stlb_header;
|
const struct gmio_stlb_header* stlb_header;
|
||||||
|
|
||||||
/*! Count of mesh facets(triangles)
|
/*! Count of mesh facets(triangles).
|
||||||
*
|
* Available only if binary STL, \c 0 otherwise */
|
||||||
* Available only if binary STL, \c 0 otherwise
|
|
||||||
*/
|
|
||||||
uint32_t stlb_triangle_count;
|
uint32_t stlb_triangle_count;
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -109,8 +103,7 @@ struct gmio_stl_mesh_creator
|
|||||||
/*! Optional pointer on a function that finalizes creation of the user mesh
|
/*! Optional pointer on a function that finalizes creation of the user mesh
|
||||||
*
|
*
|
||||||
* The function is called at the end of the read process, ie. after all
|
* The function is called at the end of the read process, ie. after all
|
||||||
* triangles have been added
|
* triangles have been added */
|
||||||
*/
|
|
||||||
void (*func_end_solid)(void* cookie);
|
void (*func_end_solid)(void* cookie);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -31,7 +31,6 @@
|
|||||||
|
|
||||||
#include <QtCore/QFile>
|
#include <QtCore/QFile>
|
||||||
#include <QtCore/QIODevice>
|
#include <QtCore/QIODevice>
|
||||||
|
|
||||||
#include <cstring>
|
#include <cstring>
|
||||||
|
|
||||||
QT_USE_NAMESPACE
|
QT_USE_NAMESPACE
|
||||||
|
@ -28,7 +28,7 @@
|
|||||||
****************************************************************************/
|
****************************************************************************/
|
||||||
|
|
||||||
/*! \file stream_qt.h
|
/*! \file stream_qt.h
|
||||||
* Support of Qt's QIODevice (requires at least Qt4)
|
* Support of Qt's \c QIODevice (requires at least Qt4)
|
||||||
*
|
*
|
||||||
* \addtogroup gmio_support
|
* \addtogroup gmio_support
|
||||||
* @{
|
* @{
|
||||||
|
Loading…
Reference in New Issue
Block a user