diff options
author | Campbell Barton <ideasman42@gmail.com> | 2022-01-06 11:00:35 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2022-01-06 11:25:24 +0300 |
commit | 6f389f1bb856df2a1d9d29bc542b5ad76748a84e (patch) | |
tree | b465e79710bd87896ab7a979cef6727795528e87 /source/blender/io/wavefront_obj/exporter/obj_exporter.hh | |
parent | c12607baa3a45eeceaf084c1e8b537183b6cc07e (diff) |
Cleanup: move public doc-strings into headers
Some recent changes re-introduced public-style doc-strings
in the source file.
Diffstat (limited to 'source/blender/io/wavefront_obj/exporter/obj_exporter.hh')
-rw-r--r-- | source/blender/io/wavefront_obj/exporter/obj_exporter.hh | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/source/blender/io/wavefront_obj/exporter/obj_exporter.hh b/source/blender/io/wavefront_obj/exporter/obj_exporter.hh index e02a240b51a..1a193bf437f 100644 --- a/source/blender/io/wavefront_obj/exporter/obj_exporter.hh +++ b/source/blender/io/wavefront_obj/exporter/obj_exporter.hh @@ -51,6 +51,9 @@ class OBJDepsgraph : NonMovable, NonCopyable { * Depending on whether or not `export_params.export_animation` is set, it writes * either one file per animation frame, or just one file. */ +/** + * Central internal function to call Scene update & writer functions. + */ void exporter_main(bContext *C, const OBJExportParams &export_params); class OBJMesh; @@ -62,6 +65,11 @@ class OBJCurve; * The output file name is given by `filepath`. * This function is normally called from `exporter_main`, but is exposed here for testing purposes. */ +/** + * Export a single frame to a .OBJ file. + * + * Conditionally write a .MTL file also. + */ void export_frame(Depsgraph *depsgraph, const OBJExportParams &export_params, const char *filepath); @@ -84,5 +92,10 @@ filter_supported_objects(Depsgraph *depsgraph, const OBJExportParams &export_par * be `filepath` with its "#" characters replaced by the number representing `frame`, and with * a .obj extension. */ +/** + * Append the current frame number in the .OBJ file name. + * + * \return Whether the filepath is in #FILE_MAX limits. + */ bool append_frame_to_filename(const char *filepath, const int frame, char *r_filepath_with_frames); } // namespace blender::io::obj |