======================================================
[](https://travis-ci.org/fougue/gmio)
[](https://ci.appveyor.com/project/HuguesDelorme/gmio)
[](https://coveralls.io/github/fougue/gmio?branch=master)
[](http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html)
C library for geometry input/output
===========================================
gmio is a reusable C library providing complete I/O support for various CAD file
formats (eg. [STL](https://en.wikipedia.org/wiki/STL_%28file_format%29))
gmio aims to be [fast](https://github.com/fougue/gmio/wiki/4.-Benchmarks),
portable (C90 conformance) and feature-rich.
Main highlights:
* [x] "Abstract" streams that does not tie the user to C stream(`FILE*`)
* [x] Buffering of input/ouput for efficient device usage
* [x] Operations can be easily aborted
* [x] Progress report about the I/O operation
* [x] Available under the CeCILL-B license, which is fully BSD compatible
Supported CAD files format
==========================
Current version only supports the STL file format (STereoLithography), but
support is complete :
* [x] ASCII format: Case-insensitive reading
* [x] ASCII format: Output format(%f, %e, ...) and precision of floats support
* [x] Binary format: Little/big endian support
* [x] Binary format: 80-byte header and facet "attribute byte count" support
* [x] Detection of the input format
* [x] Retrieval of infomations about contents(facet count, solid name, ...)
* [x] Multiple solids from stream(eg. 4 solids in STL ascii file)
In addition, the STL module has the following advatanges:
* [x] The user keeps its own geometry data structures, no mesh conversion needed
* [x] Fixed memory consumption and independant of the mesh size
* [x] Seamless use of OpenCascade
[StlMesh_Mesh](http://dev.opencascade.org/doc/refman/html/class_stl_mesh___mesh.html)
and [MeshVS_DataSource](http://dev.opencascade.org/doc/refman/html/class_mesh_v_s___data_source.html)
in gmio
Building gmio
=============
gmio can be built with CMake, by default a static library is generated.
Read the [Build instructions](https://github.com/fougue/gmio/wiki/2.-Build-instructions)
Documentation
=============
The HTML reference manual generated by Doxygen is [here](http://www.fougue.pro/docs/gmio)
There is also a [wiki](https://github.com/fougue/gmio/wiki)
How to report a bug
===================
The gmio bug tracking system is open to the public at
https://github.com/fougue/gmio/issues.
If you think you have found a bug in gmio, we would like to hear
about it so that we can fix it.
Always include the following information in your bug report:
* the name and version number of your compiler
* the name and version number of your operating system
* the version of gmio you are using
* 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.
License
=======
This software is governed by the CeCILL-B license under French law and
abiding by the rules of distribution of free software.
You can use, modify and/ or redistribute the software under the terms of the
[CeCILL-B license](http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html)
as circulated by CEA, CNRS and INRIA
Credits
=======
"gmio" logo rendered with Prism font (thanks to Erik Yin !)