2016-03-14 22:53:22 +08:00
|
|
|
/*! \mainpage
|
|
|
|
|
|
|
|
|
|
\section intro Introduction
|
|
|
|
|
|
2016-03-25 20:08:17 +08:00
|
|
|
gmio is a reusable C library providing complete I/O support for various CAD
|
2016-04-27 22:11:00 +08:00
|
|
|
file formats(eg. <a href="https://en.wikipedia.org/wiki/STL_%28file_format%29">STL</a>)
|
2016-03-14 22:53:22 +08:00
|
|
|
|
2017-04-05 18:54:11 +08:00
|
|
|
gmio aims to be <a href="https://github.com/fougue/gmio/wiki/v0.4-Benchmarks">fast</a>,
|
2017-02-24 19:51:28 +08:00
|
|
|
portable(C99 conformance) and feature-rich.
|
2016-03-14 22:53:22 +08:00
|
|
|
Main highlights:
|
|
|
|
|
|
2016-04-27 22:11:00 +08:00
|
|
|
\li <i>Abstract</i> streams that does not tie the user to C stream(\c FILE*)
|
2016-03-14 22:53:22 +08:00
|
|
|
\li Buffering of input/ouput for efficient device usage
|
|
|
|
|
\li Operations can be easily aborted
|
|
|
|
|
\li Progress report about the I/O operation
|
|
|
|
|
|
2017-02-24 19:51:28 +08:00
|
|
|
|
|
|
|
|
Supported formats | Read | Write
|
|
|
|
|
--------------------------|--------|---------
|
|
|
|
|
AMF uncompressed | no | yes
|
|
|
|
|
AMF zip | no | yes
|
|
|
|
|
AMF zip64 | no | yes
|
2017-04-05 18:54:11 +08:00
|
|
|
STL ascii | yes | yes
|
|
|
|
|
STL binary(little-endian) | yes | yes
|
|
|
|
|
STL binary(big-endian) | yes | yes
|
2017-02-24 19:51:28 +08:00
|
|
|
|
2016-03-14 22:53:22 +08:00
|
|
|
|
|
|
|
|
\section build Building gmio
|
|
|
|
|
|
|
|
|
|
gmio can be built with CMake, by default a static library is generated.
|
|
|
|
|
|
2017-04-05 18:54:11 +08:00
|
|
|
Read the <a href="https://github.com/fougue/gmio/wiki/v0.4-Build-instructions">Build instructions</a>
|
2016-03-14 22:53:22 +08:00
|
|
|
|
|
|
|
|
\section bug_report How to report a bug
|
|
|
|
|
|
|
|
|
|
If you think you have found a bug in gmio, we would like to hear
|
|
|
|
|
about it so that we can fix it.\n
|
|
|
|
|
The gmio bug tracking system is open to the public at https://github.com/fougue/gmio/issues.
|
|
|
|
|
|
|
|
|
|
Always include the following information in your bug report:
|
|
|
|
|
\li the name and version number of your compiler
|
|
|
|
|
\li the name and version number of your operating system
|
|
|
|
|
\li the version of gmio you are using
|
|
|
|
|
\li what configure options it was compiled with.
|
|
|
|
|
|
|
|
|
|
If the problem you are reporting is only visible at run-time, try to
|
|
|
|
|
create a small test program that shows the problem when run.
|
|
|
|
|
|
|
|
|
|
\section lic License
|
|
|
|
|
|
2016-07-05 18:46:22 +08:00
|
|
|
gmio is made available under a "2-clause" BSD
|
|
|
|
|
<a href="https://github.com/fougue/gmio/blob/master/LICENSE.txt">license</a>.
|
2016-03-14 22:53:22 +08:00
|
|
|
|
|
|
|
|
\section creds Credits
|
|
|
|
|
|
2016-04-27 22:11:00 +08:00
|
|
|
"gmio" logo rendered with Prism font(thanks to Erik Yin !)
|
2016-03-14 22:53:22 +08:00
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/*!
|
|
|
|
|
\example ../examples/occstl_read_file.cpp
|
|
|
|
|
\example ../examples/occstl_redefine_mesh_creator.cpp
|
|
|
|
|
\example ../examples/occstl_write_file.cpp
|
|
|
|
|
\example ../examples/stl_get_infos.c
|
|
|
|
|
\example ../examples/stl_read_file.c
|
|
|
|
|
\example ../examples/stl_write_file.c
|
|
|
|
|
*/
|
