summaryrefslogtreecommitdiffstats
path: root/libdimension/dimension/lights.h
diff options
context:
space:
mode:
Diffstat (limited to 'libdimension/dimension/lights.h')
-rw-r--r--libdimension/dimension/lights.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/libdimension/dimension/lights.h b/libdimension/dimension/lights.h
index 7b7385e..7c0f140 100644
--- a/libdimension/dimension/lights.h
+++ b/libdimension/dimension/lights.h
@@ -18,13 +18,20 @@
* <http://www.gnu.org/licenses/>. *
*************************************************************************/
-/*
- * Types of lights.
+/**
+ * @file
+ * Pre-defined light types.
*/
#ifndef DIMENSION_LIGHTS_H
#define DIMENSION_LIGHTS_H
+/**
+ * A point light.
+ * @param[in] x0 The origin of the light.
+ * @param[in] color The color of the light.
+ * @return A point light.
+ */
dmnsn_light *dmnsn_new_point_light(dmnsn_vector x0, dmnsn_color color);
#endif /* DIMENSION_LIGHTS_H */