|
9 | 9 | //! The following features are all non-default features to reduce the amount of additional dependencies. |
10 | 10 | //! |
11 | 11 | //! - **`vtk_extras`**: Enables helper functions and trait implementations to export meshes using [`vtkio`](https://github.com/elrnv/vtkio). |
12 | | -//! In particular it adds `From` impls for the [mesh] types used by this crate to convert them to |
13 | | -//! [`vtkio::model::UnstructuredGridPiece`](https://docs.rs/vtkio/0.6.*/vtkio/model/struct.UnstructuredGridPiece.html) and [`vtkio::model::DataSet`](https://docs.rs/vtkio/0.6.*/vtkio/model/enum.DataSet.html) |
14 | | -//! types. If the feature is enabled, The crate exposes its `vtkio` dependency as `splashsurflib::vtkio`. |
| 12 | +//! In particular it adds `From` impls for the [mesh] types used by this crate to convert them to |
| 13 | +//! [`vtkio::model::UnstructuredGridPiece`](https://docs.rs/vtkio/0.6.*/vtkio/model/struct.UnstructuredGridPiece.html) and [`vtkio::model::DataSet`](https://docs.rs/vtkio/0.6.*/vtkio/model/enum.DataSet.html) |
| 14 | +//! types. If the feature is enabled, The crate exposes its `vtkio` dependency as `splashsurflib::vtkio`. |
15 | 15 | //! - **`io`**: Enables the [`io`] module, containing functions to load and store particle and mesh files |
16 | | -//! from various file formats, e.g. `VTK`, `OBJ`, `BGEO` etc. This feature implies the `vtk_extras` feature. |
17 | | -//! It is disabled by default because a pure "online" surface reconstruction might not need any file IO. |
18 | | -//! The feature adds several dependencies to support the file formats. |
| 16 | +//! from various file formats, e.g. `VTK`, `OBJ`, `BGEO` etc. This feature implies the `vtk_extras` feature. |
| 17 | +//! It is disabled by default because a pure "online" surface reconstruction might not need any file IO. |
| 18 | +//! The feature adds several dependencies to support the file formats. |
19 | 19 | //! - **`profiling`**: Enables profiling of internal functions. The resulting data can be displayed using the functions |
20 | | -//! from the [`profiling`] module of this crate. Furthermore, it exposes the [`profile`] macro that can be used e.g. |
21 | | -//! by binary crates calling into this library to add their own profiling scopes to the measurements. |
22 | | -//! If this features is not enabled, the macro will just expend to a no-op and remove the (small) |
23 | | -//! performance overhead of the profiling. |
| 20 | +//! from the [`profiling`] module of this crate. Furthermore, it exposes the [`profile`] macro that can be used e.g. |
| 21 | +//! by binary crates calling into this library to add their own profiling scopes to the measurements. |
| 22 | +//! If this features is not enabled, the macro will just expend to a no-op and remove the (small) |
| 23 | +//! performance overhead of the profiling. |
24 | 24 | //! |
25 | 25 |
|
26 | 26 | use log::info; |
|
0 commit comments