gmio_stl: move param doc inline
This commit is contained in:
Hugues Delorme
parent
ef7538a4c8
commit
56142b5826
@ -31,13 +31,6 @@
|
||||
GMIO_C_LINKAGE_BEGIN
|
||||
|
||||
/*! Reads STL mesh from file, format is automatically guessed
|
||||
*
|
||||
* \param filepath Path to the STL file. A stream is opened with fopen() so
|
||||
* the string shall follow the file name specifications of the running
|
||||
* environment
|
||||
* \param creator Defines the callbacks for the mesh creation
|
||||
* \param task_iface The interface object by which the read operation can be
|
||||
* controlled. Optional, can be safely set to NULL
|
||||
*
|
||||
* Internally, it uses:
|
||||
* \li the builtin stream wrapper around FILE* (see gmio_stream_stdio())
|
||||
@ -48,33 +41,33 @@ GMIO_C_LINKAGE_BEGIN
|
||||
*/
|
||||
GMIO_LIBSTL_EXPORT
|
||||
int gmio_stl_read_file(
|
||||
/*! Path to the STL file.
|
||||
* A stream is opened with fopen() so the string shall follow the file
|
||||
* name specifications of the running environment */
|
||||
const char* filepath,
|
||||
|
||||
/*! Defines the callbacks for the mesh creation */
|
||||
gmio_stl_mesh_creator_t* creator,
|
||||
gmio_task_iface_t* task_iface);
|
||||
|
||||
/*! The interface object by which the read operation can be controlled.
|
||||
* Optional, can be safely set to NULL */
|
||||
gmio_task_iface_t* task_iface
|
||||
);
|
||||
|
||||
/*! Reads STL mesh from stream, format is automatically guessed
|
||||
*
|
||||
* \param trsf Defines needed objects for the read operation
|
||||
* \param creator Defines the callbacks for the mesh creation
|
||||
*
|
||||
* \return Error code (see error.h and stl_error.h)
|
||||
*/
|
||||
GMIO_LIBSTL_EXPORT
|
||||
int gmio_stl_read(
|
||||
/*! Defines needed objects for the read operation */
|
||||
gmio_transfer_t* trsf,
|
||||
gmio_stl_mesh_creator_t* creator);
|
||||
|
||||
/*! Defines the callbacks for the mesh creation */
|
||||
gmio_stl_mesh_creator_t* creator
|
||||
);
|
||||
|
||||
/*! Writes STL mesh to file
|
||||
*
|
||||
* \param format STL format of the output file
|
||||
* \param filepath Path to the STL file. A stream is opened with fopen() so
|
||||
* the string shall follow the file name specifications of the running
|
||||
* environment
|
||||
* \param mesh Defines the mesh to output
|
||||
* \param task_iface The interface object by which the write operation can be
|
||||
* controlled. Optional, can be safely set to NULL
|
||||
* \param options Options for the write operation, can be safely set to NULL
|
||||
* to use default values
|
||||
*
|
||||
* Internally, it uses:
|
||||
* \li the builtin stream wrapper around FILE* (see gmio_stream_stdio())
|
||||
@ -85,33 +78,47 @@ int gmio_stl_read(
|
||||
*/
|
||||
GMIO_LIBSTL_EXPORT
|
||||
int gmio_stl_write_file(
|
||||
/*! STL format of the output file */
|
||||
gmio_stl_format_t format,
|
||||
|
||||
/*! Path to the STL file. A stream is opened with fopen() so the string
|
||||
* shall follow the file name specifications of the running
|
||||
* environment */
|
||||
const char* filepath,
|
||||
|
||||
/*! Defines the mesh to output */
|
||||
const gmio_stl_mesh_t* mesh,
|
||||
|
||||
/*! The interface object by which the write operation can be controlled.
|
||||
* Optional, can be safely set to NULL */
|
||||
gmio_task_iface_t* task_iface,
|
||||
const gmio_stl_write_options_t* options);
|
||||
|
||||
/*! Options for the write operation, can be safely set to NULL to use
|
||||
* default values */
|
||||
const gmio_stl_write_options_t* options
|
||||
);
|
||||
|
||||
/*! Writes STL mesh to stream
|
||||
*
|
||||
* \param format STL format of the output
|
||||
* \param trsf Defines needed objects for the write operation
|
||||
* \param mesh Defines the mesh to output
|
||||
* \param options Options for the write operation, can be safely set to NULL
|
||||
* to use default values
|
||||
*
|
||||
* \return Error code (see error.h and stl_error.h)
|
||||
*/
|
||||
GMIO_LIBSTL_EXPORT
|
||||
int gmio_stl_write(
|
||||
/*! STL format of the output */
|
||||
gmio_stl_format_t format,
|
||||
|
||||
/*! Defines needed objects for the write operation */
|
||||
gmio_transfer_t* trsf,
|
||||
|
||||
/*! Defines the mesh to output */
|
||||
const gmio_stl_mesh_t* mesh,
|
||||
const gmio_stl_write_options_t* options);
|
||||
|
||||
/*! Options for the write operation, can be safely set to NULL to use
|
||||
* default values */
|
||||
const gmio_stl_write_options_t* options
|
||||
);
|
||||
|
||||
/*! Reads geometry from STL ascii stream
|
||||
*
|
||||
* \param trsf Defines needed objects for the read operation
|
||||
* \param creator Defines the callbacks for the mesh creation
|
||||
*
|
||||
* Stream size is passed to gmio_task_iface::func_handle_progress() as the
|
||||
* \p max_value argument.
|
||||
@ -124,17 +131,17 @@ int gmio_stl_write(
|
||||
*/
|
||||
GMIO_LIBSTL_EXPORT
|
||||
int gmio_stla_read(
|
||||
/*! Defines needed objects for the read operation */
|
||||
gmio_transfer_t* trsf,
|
||||
gmio_stl_mesh_creator_t* creator);
|
||||
|
||||
/*! Defines the callbacks for the mesh creation */
|
||||
gmio_stl_mesh_creator_t* creator
|
||||
);
|
||||
|
||||
/*! Size(in bytes) of the minimum contents possible with the STL binary format */
|
||||
enum { GMIO_STLB_MIN_CONTENTS_SIZE = 284 };
|
||||
|
||||
/*! Reads geometry from STL binary stream
|
||||
*
|
||||
* \param trsf Defines needed objects for the read operation
|
||||
* \param creator Defines the callbacks for the mesh creation
|
||||
* \param byte_order Byte order of the input STL binary data
|
||||
*
|
||||
* \return Error code (see error.h and stl_error.h)
|
||||
* \retval GMIO_ERROR_INVALID_BUFFER_SIZE
|
||||
@ -142,30 +149,38 @@ enum { GMIO_STLB_MIN_CONTENTS_SIZE = 284 };
|
||||
*/
|
||||
GMIO_LIBSTL_EXPORT
|
||||
int gmio_stlb_read(
|
||||
/*! Defines needed objects for the read operation */
|
||||
gmio_transfer_t* trsf,
|
||||
|
||||
/*! Defines the callbacks for the mesh creation */
|
||||
gmio_stl_mesh_creator_t* creator,
|
||||
gmio_endianness_t byte_order);
|
||||
|
||||
/*! Byte order of the input STL binary data */
|
||||
gmio_endianness_t byte_order
|
||||
);
|
||||
|
||||
/*! Writes STL binary header data to stream
|
||||
*
|
||||
* This functions only writes the 80-bytes header array and the count of facets
|
||||
* in the mesh(with respect of the specified byte order).
|
||||
*
|
||||
* \param stream Output stream where is written the header data
|
||||
* \param byte_order Byte order of the output STL data
|
||||
* \param header 80-bytes array of header data, can be safely set to NULL (to
|
||||
* generate an array of zeroes)
|
||||
* \param facet_count Total count of facets (triangles) in the mesh to be
|
||||
* written
|
||||
*
|
||||
* \return Error code (see error.h and stl_error.h)
|
||||
*/
|
||||
GMIO_LIBSTL_EXPORT
|
||||
int gmio_stlb_write_header(
|
||||
/*! Output stream where is written the header data */
|
||||
gmio_stream_t* stream,
|
||||
|
||||
/*! Byte order of the output STL data */
|
||||
gmio_endianness_t byte_order,
|
||||
|
||||
/*! 80-bytes array of header data, can be safely set to NULL to generate
|
||||
* an array of zeroes */
|
||||
const gmio_stlb_header_t* header,
|
||||
uint32_t facet_count);
|
||||
|
||||
/*! Total count of facets (triangles) in the mesh to be written */
|
||||
uint32_t facet_count
|
||||
);
|
||||
|
||||
GMIO_C_LINKAGE_END
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user