summaryrefslogtreecommitdiffstats
path: root/libdimension/dimension/raytrace.h
diff options
context:
space:
mode:
Diffstat (limited to 'libdimension/dimension/raytrace.h')
-rw-r--r--libdimension/dimension/raytrace.h16
1 files changed, 13 insertions, 3 deletions
diff --git a/libdimension/dimension/raytrace.h b/libdimension/dimension/raytrace.h
index f145d5f..2fee879 100644
--- a/libdimension/dimension/raytrace.h
+++ b/libdimension/dimension/raytrace.h
@@ -18,15 +18,25 @@
* <http://www.gnu.org/licenses/>. *
*************************************************************************/
-/*
- * Render a scene by raytracing
+/**
+ * @file
+ * Ray-trace a scene.
*/
#ifndef DIMENSION_RAYTRACE_H
#define DIMENSION_RAYTRACE_H
-/* Render a scene by raytracing */
+/**
+ * Render a scene by raytracing.
+ * @param[in,out] scene The scene to render.
+ */
void dmnsn_raytrace_scene(dmnsn_scene *scene);
+
+/**
+ * Render a scene in the background.
+ * @param[in,out] scene The scene to render.
+ * @return A \p dmnsn_progress object.
+ */
dmnsn_progress *dmnsn_raytrace_scene_async(dmnsn_scene *scene);
#endif /* DIMENSION_RAYTRACE_H */